Skip to content

Commit d15df1d

Browse files
committed
Add description to commands in README
1 parent 9b99d8c commit d15df1d

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Git shortcuts for implementing the scalable git branching model
22

3+
The Scalable Git Branching Model has recently been updated; see the new
4+
terminology in [A scalable Git branching model,
5+
Revisited](https://dekrey.net/articles/scalable-git-branching-model-revisited/).
6+
37
## Prerequisites
48

59
- Powershell Core (7+)
@@ -25,34 +29,34 @@ Note: if you have an older version installed, such as .NET 7, you can [install a
2529

2630
Relative paths work, too. To clone and run, you may use the following commands:
2731

28-
git clone https://github.com/PrincipleStudios/scalable-git-branching-tools.git ../scalable-git-branching-tools
32+
git clone https://github.com/DarkPatternsDigital/scalable-git-branching-tools.git ../scalable-git-branching-tools
2933
../scalable-git-branching-tools/init.ps1
3034

3135
## Commands
3236

33-
[`git tool-update`](./docs/tool-update.md)
37+
[`git tool-update`](./docs/tool-update.md) - Attempts to update these tools
3438

35-
[`git tool-config`](./docs/tool-config.md)
39+
[`git tool-config`](./docs/tool-config.md) - Configures these tools
3640

37-
[`git new`](./docs/new.md)
41+
[`git new`](./docs/new.md) - Create a new branch with tracked dependencies
3842

39-
[`git pull-deps`](./docs/pull-deps.md)
43+
[`git pull-deps`](./docs/pull-deps.md) - Pull dependencies into your current branch
4044

41-
[`git show-dependants`](./docs/show-dependants.md)
45+
[`git show-dependants`](./docs/show-dependants.md) - Shows dependants of the current branch
4246

43-
[`git show-deps`](./docs/show-deps.md)
47+
[`git show-deps`](./docs/show-deps.md) - Shows dependencies of the current branch
4448

45-
[`git add-deps`](./docs/add-deps.md)
49+
[`git add-deps`](./docs/add-deps.md) - Adds one or more dependencies to the current branch
4650

47-
[`git rc`](./docs/rc.md)
51+
[`git rc`](./docs/rc.md) - Creates a release candidate out of one or more dependencies
4852

49-
[`git rebuild-rc`](./docs/rebuild-rc.md)
53+
[`git rebuild-rc`](./docs/rebuild-rc.md) - Recreates a release candidate, modifying its dependencies.
5054

51-
[`git verify-updated`](./docs/verify-updated.md)
55+
[`git verify-updated`](./docs/verify-updated.md) - Verifies if the current branch is up-to-date wit its dependencies
5256

53-
[`git refactor-deps`](./docs/refactor-deps.md)
57+
[`git refactor-deps`](./docs/refactor-deps.md) - Rewrites the dependencies tree as directed
5458

55-
[`git release`](./docs/release.md)
59+
[`git release`](./docs/release.md) - Releases and cleans up branches
5660

5761
## Development
5862

0 commit comments

Comments
 (0)