Skip to content

Commit 7ee5bf4

Browse files
author
shussain249
committed
Update install instruction to align with latest makefile
Makefile seem to have been updated in #ff8aa6b346bd4fe6781fe70a463457c331dcc945. This PR is just updating the README.md to use make install instead of make build for the end users. Coupled are just minor auto-format changes.
1 parent d44b4f6 commit 7ee5bf4

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ Git Chain automates this entire process. It keeps track of relationships between
2828
- **Root Branch**: The foundation branch (typically `main` or `master`) that the chain ultimately merges into.
2929
- **Branch Order**: The sequence in which branches depend on each other in the chain.
3030

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

3535
## How Git Chain Works
3636

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

@@ -439,7 +439,7 @@ error: Merge conflict between feature/auth and feature/profiles
439439
✅ Successful merges: 1
440440
⚠️ Merge conflicts: 1
441441
- feature/auth into feature/profiles
442-
442+
443443
⚠️ Chain feature was partially merged with conflicts.
444444
Run `git status` to see conflicted files.
445445
After resolving conflicts, continue with regular git commands:
@@ -468,13 +468,9 @@ error: Merge conflict between feature/auth and feature/profiles
468468
git clone https://github.com/evansst/git-chain.git
469469
cd git-chain
470470
```
471-
3. Build the tool:
472-
```
473-
make build
474-
```
475-
4. Make it available on your system:
471+
3. Install the tool:
476472
```
477-
cp target/release/git-chain /usr/local/bin/
473+
make install
478474
```
479475

480476
This allows you to use the tool with:
@@ -634,7 +630,7 @@ git chain prune
634630
# Remove the current branch from its chain
635631
git chain remove
636632
637-
# Remove the entire chain
633+
# Remove the entire chain
638634
git chain remove --chain
639635
640636
# Remove a specific chain
@@ -671,4 +667,4 @@ If you need more features, check out these alternatives:
671667

672668
## License
673669

674-
MIT
670+
MIT

0 commit comments

Comments
 (0)