On 2013-10-18, Gabriel Guzman <[email protected]> wrote:
> +<h3>Does my package need a readme?</h3>
> +A package may require special instructions to run on OpenBSD, or
> +additional files may need to be downloaded before the port will work
> +properly, or your port may rely on additional packages to support
> +additional functionality. If this is the case, and you are unable to
new sentence, new line
> +provide those features via flavors, a readme may be warranted.
I wouldn't talk about flavours here, this encourages people to add
flavours just for optional deps
> +
> +<h3>Creating and installing a readme</h3>
> +You can create a README file in the pkg directory of your port with
> +the relevant information. Once your file is complete, add
should tell people to base it on infrastructure/README.template
> +<blockquote><pre>
> +@cwd ${LOCALBASE}/share/doc/pkg-readmes
> +${FULLPKGNAME}
> +</pre></blockquote>
> +to your generated PLIST file. This will allow the pkg tools to copy
> +your README to /usr/local/share/doc/pkg-readmes/ when your port is
> +installed, and notify the user to check there for additional
> +information.
Adding this manually with @cwd is only for things where PREFIX has
been changed, normally "make plist" picks this up by itself..
