From 8de61fb5a03d19329432231db6a20fb9ff350a48 Mon Sep 17 00:00:00 2001 From: Andrew Brandt Date: Wed, 27 Aug 2025 13:14:14 -0500 Subject: [PATCH] docs: update the README with build instructions **Description**: Update the README doc with build instructions Signed-off-by: Andrew Brandt --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 4ba17e7..7755d82 100644 --- a/README.md +++ b/README.md @@ -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 ` 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