Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build Instructions #1

Open
bambams opened this issue Feb 19, 2018 · 1 comment
Open

Build Instructions #1

bambams opened this issue Feb 19, 2018 · 1 comment

Comments

@bambams
Copy link

bambams commented Feb 19, 2018

Please post build instructions into either a README or INSTALL or something similar file.

While I'm on that subject, typically the README file is in the root. I don't think there's any value having it tucked away in docs/. Usually more detailed documentation goes into a directory. The main files like COPYING, INSTALL, and README are usually found in the root to guide you around the rest of the tree.

@NewCreature
Copy link
Owner

This commit adds build instructions.

I don't plan to reorganize the source tree to match other open source projects. I do plan on placing a source.txt in the root explaining the source tree layout. I keep all documents that are distributed with binary packages in the docs directory to simplify packaging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants