Skip to content

Commit 9f616f7

Browse files
authored
Merge pull request #34 from github/dashes-for-everyone
Change the instructions to work if `git-sizer` is *not* in PATH
2 parents 50eeafc + e46da29 commit 9f616f7

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,11 @@ Is your Git repository bursting at the seams?
8080

8181
3. Change to the directory containing a full, non-shallow clone of the Git repository that you'd like to analyze. Then run
8282

83-
git sizer [<option>...]
83+
git-sizer [<option>...]
8484

85-
No options are required. You can learn about available options by typing `git sizer -h` or by reading on.
85+
No options are required. You can learn about available options by typing `git-sizer -h` or by reading on.
8686

87-
(The above command assumes that you have added `git-sizer` to your `PATH`. If you don't add it to your `PATH`, you need to type its full path and filename to run it; e.g., `/path/to/bin/git-sizer`.)
87+
**Pro tip**: If you add `git-sizer` to your `PATH`, then you can run it by typing either `git-sizer` or `git sizer`. In the latter case, it is found and run for you by Git, and you can add extra Git options between the two words, like `git -C /path/to/my/repo sizer`. If you don't add `git-sizer` to your `PATH`, then of course you need to type its full path and filename to run it; e.g., `/path/to/bin/git-sizer`. In either case, the `git` executable *must* be in your `PATH`.
8888

8989

9090
## Usage
@@ -177,7 +177,7 @@ If you'd like the output in machine-readable format, including exact numbers, us
177177

178178
To get a list of other options, run
179179

180-
git sizer -h
180+
git-sizer -h
181181

182182
The Linux repository is large by most standards. As you can see, it is pushing some of Git's limits. And indeed, some Git operations on the Linux repository (e.g., `git fsck`, `git gc`) do take a while. But due to its sane structure, none of its dimensions are wildly out of proportion to the size of the code base, so the kernel project is managed successfully using Git.
183183

0 commit comments

Comments
 (0)