An overhaul of the BoostSRL README.md: including sections for Getting Started, Installation, Basic Usage, Contributing, Versioning, and Acknowledgements.
Fixes the broken README links (refer to Issue #3).
Links are reorganized into a table structure with shields for Latest Release and a fixed License shield.
New file:.github/CONTRIBUTING.md
.github/ directory is for markdown and information GitHub uses. CONTRIBUTING.md contains some contribution guidelines for BoostSRL, notably How to ask a question, How to file a bug report, and How to suggest a new feature.
New directory:docs/
A large portion of the documentation for WILL was buried in the code (/src/edu/wisc/cs/will/ILP/willmanual/), this documentation may be appropriate to have around, so documentation was moved to a directory specifically for this type of information. docs/ will be used for this purpose.
README.md changes:
Latest Release
and a fixedLicense
shield.New file:
.github/CONTRIBUTING.md
.github/
directory is for markdown and information GitHub uses.CONTRIBUTING.md
contains some contribution guidelines for BoostSRL, notably How to ask a question, How to file a bug report, and How to suggest a new feature.New directory:
docs/
A large portion of the documentation for WILL was buried in the code (
/src/edu/wisc/cs/will/ILP/willmanual/
), this documentation may be appropriate to have around, so documentation was moved to a directory specifically for this type of information.docs/
will be used for this purpose.