Skip to content

Commit 125b002

Browse files
Update README.md
1 parent ac50675 commit 125b002

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,15 @@
77

88
Generate dummy Git repositories and populate them with the desired number of commits, branches, and structure.
99

10-
Example: `$ git-dummy --commits=5`
10+
Example: `$ git-dummy --commits=10 --branches=2`
1111

12-
This will initialize a new Git repo in the current directory with 5 commits on a single branch.
12+
This will initialize a new Git repo in the current directory with 2 branches, each containing 10 commits.
13+
14+
Note: All generated dummy repos have at minimum 1 branch called `main`. For dummies with multiple branches, branches are named `branch1, branch2, ..., branchN`. Each branch currently branches off of `main` at a randomly chosen commit. The length of each branch is capped at the number of commits specified by `--commits`.
1315

1416
## Use cases
1517
- Programatically generate Git repos for functional testing of Git tools
18+
- Decide how many commits and branches are generated
1619
- Mimic scenarios in real Git repos to practice on without touching real data
1720
- Generate Git demo repos to teach or learn from
1821

@@ -57,6 +60,7 @@ Available options and flags include:
5760

5861
`--name`: The name of the dummy Git repo, defaults to "dummy".
5962
`--commits`: The number of commits to populate in the dummy Git repo, defaults to 5.
63+
`--branches`: The number of branches to generate in the dummy Git repo, defaults to 1.
6064
`--git-dir`: The path at which to store the dummy Git repo, defaults to current directory.
6165

6266
## Basic command examples

0 commit comments

Comments
 (0)