Skip to content

docs: update the README with build instructions #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 27, 2025
Merged

docs: update the README with build instructions #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@ git-semver assumes that the commit messages in the git history are well-formed a
$ docker pull psanetra/git-semver
```

## Build Process

To build locally for testing, ensure you have `go` installed.

1. `cd` to the `cli` folder of the repo.
2. Run `go build -o <output_file>` to build the package.
3. Once complete, copy the package to a location in your terminal's path.
4. Run `source ~/.bashrc` (or appropriate `.rc` file for your terminal) to include the new package.

## Commands

### latest
Expand Down