Skip to content

Update install instruction to align with latest makefile #44

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.

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ Git Chain automates this entire process. It keeps track of relationships between
- **Root Branch**: The foundation branch (typically `main` or `master`) that the chain ultimately merges into.
- **Branch Order**: The sequence in which branches depend on each other in the chain.

**Note**:
**Note**:
- A branch can belong to at most one chain.
- The root branch is not part of the chain, but serves as its foundation.

## How Git Chain Works

Git Chain stores branch relationships in your repository's Git config, tracking:
- Which chain a branch belongs to
- Which chain a branch belongs to
- The order of branches within a chain
- Each branch's root branch

Expand Down Expand Up @@ -439,7 +439,7 @@ error: Merge conflict between feature/auth and feature/profiles
✅ Successful merges: 1
⚠️ Merge conflicts: 1
- feature/auth into feature/profiles

⚠️ Chain feature was partially merged with conflicts.
Run `git status` to see conflicted files.
After resolving conflicts, continue with regular git commands:
Expand Down Expand Up @@ -468,13 +468,9 @@ error: Merge conflict between feature/auth and feature/profiles
git clone https://github.com/evansst/git-chain.git
cd git-chain
```
3. Build the tool:
```
make build
```
4. Make it available on your system:
3. Install the tool:
```
cp target/release/git-chain /usr/local/bin/
make install
```

This allows you to use the tool with:
Expand Down Expand Up @@ -634,7 +630,7 @@ git chain prune
# Remove the current branch from its chain
git chain remove

# Remove the entire chain
# Remove the entire chain
git chain remove --chain

# Remove a specific chain
Expand Down Expand Up @@ -671,4 +667,4 @@ If you need more features, check out these alternatives:

## License

MIT
MIT