https://github.com/sormuras/changelog
Render human-readable changelogs
https://github.com/sormuras/changelog
Last synced: 3 months ago
JSON representation
Render human-readable changelogs
- Host: GitHub
- URL: https://github.com/sormuras/changelog
- Owner: sormuras
- License: upl-1.0
- Created: 2024-01-25T08:31:40.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-29T15:03:44.000Z (over 2 years ago)
- Last Synced: 2025-01-12T08:45:48.168Z (over 1 year ago)
- Language: Java
- Homepage:
- Size: 8.79 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# changelog
## Installation
- Download a copy of the [ChangeLog.java](src/ChangeLog.java) file to your project.
- In your copy, edit operator constants to match your project's configuration.
- Remove also all existing change log entries to start with a blank log.
## Usage
- Add change log entries directly into your copy of the `ChangeLog.java` file.
- Run `java ChangeLog.java > CHANGELOG.md` to (re-)create or update the `CHANGELOG.md` file.
For example, the following command recreates the `CHANGELOG.md` file of this project.
```shell
java src/ChangeLog.java > CHANGELOG.md
```