-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from ktmeaton/dev
Installation Docs
- Loading branch information
Showing
1 changed file
with
10 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,17 @@ | ||
# autologs | ||
Automatically create release notes and changelog. | ||
|
||
Automatically document commit history, release notes, and a changelog. | ||
|
||
Parameters | ||
## Install | ||
|
||
1. Old version (tag or commit hash) | ||
1. New version (tag or commit hash) | ||
1. Max commits to print | ||
1. Notes directory | ||
Add as a submodule to an existing git repository. | ||
|
||
```bash | ||
git submodule add https://github.com/ktmeaton/autologs | ||
./autologs/autologs --help | ||
``` | ||
|
||
## Credits | ||
|
||
Argument Parsing: <https://medium.com/@Drew_Stokes/bash-argument-parsing-54f3b81a6a8f> | ||
Help: <https://opensource.com/article/19/12/help-bash-program> | ||
Argument Parsing: <https://medium.com/@Drew_Stokes/bash-argument-parsing-54f3b81a6a8f> | ||
Help Function: <https://opensource.com/article/19/12/help-bash-program> |