chore: add changelog, ToC
parent
665ace8bc8
commit
36cc113595
|
@ -2,19 +2,25 @@
|
||||||
|
|
||||||
> description
|
> 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
|
## System requirements
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
steps here
|
steps here
|
||||||
|
|
||||||
## Building
|
## Building/Running
|
||||||
|
|
||||||
### ENVIRONMENT 1
|
### ENVIRONMENT NAME
|
||||||
|
|
||||||
steps here
|
|
||||||
|
|
||||||
### MORE ENVIRONMENTS IF NEEDED
|
|
||||||
|
|
||||||
steps here
|
steps here
|
||||||
|
|
||||||
|
@ -22,6 +28,11 @@ steps here
|
||||||
|
|
||||||
Add contributing guidelines
|
Add contributing guidelines
|
||||||
|
|
||||||
|
## Changelog
|
||||||
|
|
||||||
|
- generate the changelog with `./changelog.sh` or `bash /path/to/changelog.sh` (requires bash)
|
||||||
|
- See the [Changelog](/CHANGELOG.md)
|
||||||
|
|
||||||
## License
|
## 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.
|
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.
|
||||||
|
|
|
@ -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
|
Loading…
Reference in New Issue