From 348f3991d5d84eb7bf14d6b9b508b992bddc1aa3 Mon Sep 17 00:00:00 2001 From: shussain249 Date: Mon, 11 Aug 2025 12:00:49 -0400 Subject: [PATCH 1/3] 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 end users. Coupled are just minor auto-format changes. --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e4307b7..5dfb848 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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: @@ -470,11 +470,7 @@ error: Merge conflict between feature/auth and feature/profiles ``` 3. Build the tool: ``` - make build - ``` -4. Make it available on your system: - ``` - cp target/release/git-chain /usr/local/bin/ + make release ``` This allows you to use the tool with: @@ -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 @@ -671,4 +667,4 @@ If you need more features, check out these alternatives: ## License -MIT \ No newline at end of file +MIT From af82e9b4f469ba8e2b61a4be6035c23dd83d981e Mon Sep 17 00:00:00 2001 From: shussain249 Date: Mon, 11 Aug 2025 12:02:52 -0400 Subject: [PATCH 2/3] Directly use make install instead of release --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5dfb848..1eb8ac7 100644 --- a/README.md +++ b/README.md @@ -470,7 +470,7 @@ error: Merge conflict between feature/auth and feature/profiles ``` 3. Build the tool: ``` - make release + make install ``` This allows you to use the tool with: From 64ecef0aa4d3c9229ea6140fc04a9dda7461ddd2 Mon Sep 17 00:00:00 2001 From: shussain249 Date: Mon, 11 Aug 2025 12:04:27 -0400 Subject: [PATCH 3/3] Update instruction header --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1eb8ac7..4b18430 100644 --- a/README.md +++ b/README.md @@ -468,7 +468,7 @@ 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: +3. Install the tool: ``` make install ```