Skip to content

Commit

Permalink
Update README.md (#17)
Browse files Browse the repository at this point in the history
  • Loading branch information
mmattel authored Nov 23, 2023
1 parent 90b4e01 commit 8be637b
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# calens

This program is a changelog generator that nicely prints a changelog file from
`calens` is a changelog generator that nicely prints a changelog file from
a directory with versioned subdirs containing files. A sample directory can be
seen in [the restic repository](https://github.com/restic/restic/tree/master/changelog)

# Installation

To install and run calens locally, run the following commands:
```
git clone https://github.com/restic/calens.git
cd calens
CGO_ENABLED=0 go install
```

# Creating a Changelog

To create a changlog.md file using calens, change into a repository containing a `changelog`
folder similar to that of [restic](https://github.com/restic/restic/tree/master/changelog).
Then run `calens -o changlog.md` from within the repository.

When done, open the created changelog to see the generated changelog.

Run `calens --help` for more options.

0 comments on commit 8be637b

Please sign in to comment.