Skip to content

Commit afbe261

Browse files
docs: update the README with build instructions (#22)
Signed-off-by: Andrew Brandt <[email protected]>
1 parent 62a8f4c commit afbe261

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,15 @@ git-semver assumes that the commit messages in the git history are well-formed a
1111
$ docker pull psanetra/git-semver
1212
```
1313

14+
## Build Process
15+
16+
To build locally for testing, ensure you have `go` installed.
17+
18+
1. `cd` to the `cli` folder of the repo.
19+
2. Run `go build -o <output_file>` to build the package.
20+
3. Once complete, copy the package to a location in your terminal's path.
21+
4. Run `source ~/.bashrc` (or appropriate `.rc` file for your terminal) to include the new package.
22+
1423
## Commands
1524

1625
### latest

0 commit comments

Comments
 (0)