scaffolding/README/README.md

39 lines
868 B
Markdown
Raw Permalink Normal View History

2022-09-08 22:44:26 +01:00
# repo name
> description
2023-02-07 15:09:04 +00:00
- [repo name](#repo-name)
- [System requirements](#system-requirements)
- [Development](#development)
- [Building/Running](#buildingrunning)
- [ENVIRONMENT NAME](#environment-name)
- [Contributing](#contributing)
- [Changelog](#changelog)
- [License](#license)
2022-09-08 22:44:26 +01:00
## System requirements
## Development
steps here
2023-02-07 15:09:04 +00:00
## Building/Running
2022-09-08 22:44:26 +01:00
2023-02-07 15:09:04 +00:00
### ENVIRONMENT NAME
2022-09-08 22:44:26 +01:00
steps here
## Contributing
Add contributing guidelines
2023-02-07 15:09:04 +00:00
## Changelog
- generate the changelog with `./changelog.sh` or `bash /path/to/changelog.sh` (requires bash)
- See the [Changelog](/CHANGELOG.md)
2022-09-08 22:44:26 +01:00
## 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.