Skip to content

Commit 5c49054

Browse files
committed
Don't pretend that the build instructions work on all platforms
1 parent 1e6b348 commit 5c49054

File tree

2 files changed

+16
-6
lines changed

2 files changed

+16
-6
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,14 +67,20 @@ Is your Git repository bursting at the seams?
6767

6868
## Getting started
6969

70-
1. Build:
70+
1. [Install the Git command-line client](https://git-scm.com/) and put it in your `PATH`. (`git-sizer` invokes `git` commands to examine the contents of your repository.)
7171

72-
script/bootstrap
73-
make
72+
2. Build:
7473

75-
The executable file is written to `bin/git-sizer`. If copy it to your `PATH` and you have Git installed, you can run the program by typing `git sizer`; otherwise, you need to type the full path and filename to run it; e.g., `bin/git-sizer`.
74+
* On Linux or OS X:
7675

77-
2. Run:
76+
script/bootstrap
77+
make
78+
79+
The executable file is written to `bin/git-sizer`. If you copy it to your `PATH`, you can run the program by typing `git sizer`; otherwise, you need to type the full path and filename to run it; e.g., `bin/git-sizer`.
80+
81+
* On other platforms: TBD
82+
83+
3. Run:
7884

7985
git sizer [<opt>...] [<path-to-git-repository>]
8086

script/install-vendored-go

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,13 @@ GO_VERSION=go1.9.2
66
if [ $(uname -s) = "Darwin" ]; then
77
GO_PKG=${GO_VERSION}.darwin-amd64.tar.gz
88
GO_PKG_SHA=8b4f6ae6deae1150d2e341d02c247fd18a99af387516540eeb84702ffd76d3a1
9-
else
9+
elif [ $(uname -s) = "Linux" ]; then
1010
GO_PKG=${GO_VERSION}.linux-amd64.tar.gz
1111
GO_PKG_SHA=de874549d9a8d8d8062be05808509c09a88a248e77ec14eb77453530829ac02b
12+
else
13+
echo 1>&2 "I don't know how to install Go on your platform."
14+
echo 1>&2 "Please install $GO_VERSION or later and add it to your PATH."
15+
exit 1
1216
fi
1317

1418
archivesum() {

0 commit comments

Comments
 (0)