chore: add changelog, ToC

main
CrimsonTome 2023-02-07 15:09:04 +00:00 committed by Rowan Clark
parent 665ace8bc8
commit 36cc113595
No known key found for this signature in database
GPG Key ID: F620D51904044094
2 changed files with 20 additions and 6 deletions

View File

@ -2,19 +2,25 @@
> 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
## Building/Running
### ENVIRONMENT 1
steps here
### MORE ENVIRONMENTS IF NEEDED
### ENVIRONMENT NAME
steps here
@ -22,6 +28,11 @@ steps here
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.

3
changelog.sh Normal file
View File

@ -0,0 +1,3 @@
#!/usr/bin/env bash
git log --date=local --format="Commit: "%h%n"Author: "%cn%n%ad%n"Commit subject: "%n%s%n > CHANGELOG