Ideally the readme.md file should be geared towards developers and enable them to easily participate in the project. In order to do so we need to have the following sections added to the Getting Started section:
Acceptance Criteria:
[ ] Overview: Minimal setup required to get L1P up and running
[ ] Built With: List of main libraries/frameworks/tools used
[ ] Prerequisites: What is needed to setup the environment
[ ] Installation: How to install/run
[ ] Dev Setup: Additional instructions to install for dev
[ ] Build/Deploy: Instructions for building / releasing a new version
[ ] Test: Instructions on testing
[ ] Licensing: State the license and how to find the text of each one
Copied from original issue: LevelOneProject/Docs#549
From @kjw000 on July 6, 2017 15:39
Ideally the readme.md file should be geared towards developers and enable them to easily participate in the project. In order to do so we need to have the following sections added to the Getting Started section:
Acceptance Criteria:
Copied from original issue: LevelOneProject/Docs#549