Makes install from source instructions clearer.
License: MIT Signed-off-by: Stephen Whitmore <noffle@ipfs.io>
Stephen Whitmore committed
Feb 27, 2016 at 11:47 UTC
e1612eba6873f0efcf322d77c92df1c9429f5f39
1 file changed
+22
-10
README.md
+22
-10
@@ -55,9 +55,9 @@ From there:
55
56
### Build from Source
57
58
-#### Prerequisite 1: Install Go
58
+#### Install Go
59
60
-First, you'll need Go. If you don't have it: [Download Go 1.5.2+](https://golang.org/dl/).
60
+First, you'll need Go. If you don't have it: [Download Go 1.5.2+](https://golang.org/dl/). **Go 1.6 is not yet supported.**
61
62
You'll need to add Go's bin directories to your `$PATH` environment variable e.g., by adding these lines to your `/etc/profile` (for a system-wide installation) or `$HOME/.profile`:
63
@@ -68,24 +68,36 @@ export PATH=$PATH:$GOPATH/bin
68
69
(If you run into trouble, see the [Go install instructions](https://golang.org/doc/install)).
70
71
-#### Prerequisite 2: Install gx and gx-go
72
-
73
-You can try using package manager, but gx and gx-go are unlikely to be available in repositories currently. The recommended way to install is to run `make toolkit_upgrade` before running `make install` in the next step.
74
-
71
#### Download + Compile IPFS
72
77
-Simply run:
73
+go-ipfs differs from the vanilla `go get` flow: it uses
74
+[gx](https://github.com/whyrusleeping/gx)/[gx-go](https://github.com/whyrusleeping/gx-go)
75
+for dependency management. This means you'll need to perform download and
76
+install steps separately.
77
+
78
+First download `go-ipfs` without installing:
79
80
```
81
$ go get -d github.com/ipfs/go-ipfs
82
+
83
$ cd $GOPATH/src/github.com/ipfs/go-ipfs
84
+```
85
+
86
+If you don't already have them on your system, install `gx` and `gx-go`:
87
+
88
+```sh
89
+$ make toolkit_upgrade
90
+```
91
+
92
+Finally, install `go-ipfs`:
93
+
94
+```
95
$ make install
96
```
97
85
-NOTES:
98
+#### Troubleshooting
99
87
-* `git` is required in order for `go get` to fetch
88
-all dependencies.
100
+* `git` is required in order for `go get` to fetch all dependencies.
101
* Package managers often contain out-of-date `golang` packages.
102
Ensure that `go version` reports at least 1.5.2. See above for how to install go.
103
* If you are interested in development, please install the development