Skip to content

Commit

Permalink
Merge pull request #1 from ktmeaton/dev
Browse files Browse the repository at this point in the history
Installation Docs
  • Loading branch information
ktmeaton authored Feb 18, 2021
2 parents 656890c + 369d26b commit 0915673
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
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>

0 comments on commit 0915673

Please sign in to comment.