Skip to content

Commit e5800e8

Browse files
committed
docs: readme update for both sourcehut and github
1 parent 50688b6 commit e5800e8

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,38 @@ You can use the exisiting binaries from the releases page or install using `go g
1010

1111
To see an example of this in action, you can check the actions file for this repo. Yes it uses itself to generate the release logs
1212

13+
## Binaries
14+
Binaries are available on the Github [releases](https://github.com/barelyhuman/commitlog/releases)
15+
16+
## Build
17+
This step is for people who want to use the latest version from the repositories which hasn't been added to releases as a binary yet and for people viewing this on sourcehut , as the binaries aren't uploaded to sourcehut.
18+
19+
- Make sure you have go installed on your system , minimum version `1.15`
20+
- You can either clone the whole repo from sourcehut / github or downlad a tar.gz from sourcehut / github
21+
22+
### With Clone
23+
24+
```sh
25+
git clone https://git.sr.ht/~reaper/commitlog
26+
# or
27+
git clone https://github.com/barelyhuman/commitlog
28+
29+
cd commitlog
30+
go build
31+
```
32+
33+
### With Tarballs
34+
```sh
35+
tar -xvzf commitlog-<hash>.tar.gz
36+
cd commitlog
37+
go build
38+
```
39+
40+
```sh
41+
# to install it to go's bin folder and use the commitlog command during dev or as a perm install
42+
go install
43+
```
44+
1345
## Usage
1446

1547
The usage is pretty simple, this cli tool assumes that you use [commitlint standards](https://github.com/conventional-changelog/commitlint#what-is-commitlint) while writing your commits, if not it's okay everything will be classified under `Other Changes` instead of being grouped according to type of commit.

0 commit comments

Comments
 (0)