scaffolding/README/README.md

39 lines
868 B
Markdown

# repo name
> description
- [repo name](#repo-name)
- [System requirements](#system-requirements)
- [Development](#development)
- [Building/Running](#buildingrunning)
- [ENVIRONMENT NAME](#environment-name)
- [Contributing](#contributing)
- [Changelog](#changelog)
- [License](#license)
## System requirements
## Development
steps here
## Building/Running
### ENVIRONMENT NAME
steps here
## Contributing
Add contributing guidelines
## Changelog
- generate the changelog with `./changelog.sh` or `bash /path/to/changelog.sh` (requires bash)
- See the [Changelog](/CHANGELOG.md)
## License
REPO-NAME is licensed under the LICENSE-NAME. The full license text is included in the [LICENSE](LICENSE.md) file in this repository. Tldr legal have a [great summary](https://tldrlegal.com/license/LICENSE-NAME) of the license if you're interested.