Re: README vs installed documentation

2017-02-12 Thread db
Thanks for the reference. I think this snippet could be mentioned under `4.7.3. 
Install Docs and Examples` in the guide, where there's already a placeholder 
header.

On 11 Feb 2017, at 23:19, Ryan Schmidt  wrote:

> 
> On Feb 11, 2017, at 13:15, db wrote:
> 
>> Sometimes the README files from tarballs is better (re completeness/clarity) 
>> than the installed documentation. Is there any way to include them by 
>> default?
> 
> If a project's build system does not automatically install the readme and 
> other documentation files, portfile authors should make the portfile install 
> them, following this recipe:
> 
> https://trac.macports.org/wiki/PortfileRecipes#doc
> 
> 



Re: README vs installed documentation

2017-02-11 Thread Ryan Schmidt

On Feb 11, 2017, at 13:15, db wrote:

> Sometimes the README files from tarballs is better (re completeness/clarity) 
> than the installed documentation. Is there any way to include them by default?

If a project's build system does not automatically install the readme and other 
documentation files, portfile authors should make the portfile install them, 
following this recipe:

https://trac.macports.org/wiki/PortfileRecipes#doc