reef-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Markus Weimer <mar...@weimo.de>
Subject Location of build information
Date Tue, 15 Mar 2016 00:35:15 GMT
Hi,

we replicate the instructions to build REEF between the wiki and the
README.md. This seems overly complicated to me, as we have to keep them
in sync.

It seems common practice in many other OSS projects to keep the build
instructions strictly with the source, e.g. in a file BUILDING.md or
BUILD.md. Should we do the same? E.g. replace the build instructions on
the wiki with a link to such a file?

Or, maybe, have a `docs` folder in our source code that contains this
information and also allows us to collect additional documentation in
the future?

Markus

Mime
View raw message