doc(README): expand the build documentation
fixes #6704
Steven Allen committed
Oct 8, 2019 at 12:48 UTC
a8bcecefdd5499e610db82c420a291b332ab7d75
1 file changed
+10
README.md
+10
@@ -149,6 +149,14 @@ PS> scoop install go-ipfs
149
150
### Build from Source
151
152
+go-ipfs's build system requires Go 1.12 and some standard POSIX build tools:
153
+
154
+* GNU make
155
+* Git
156
+* GCC (or some other go compatible C Compiler) (optional)
157
+
158
+To build without GCC, build with `CGO_ENABLED=0` (e.g., `make build CGO_ENABLED=0`).
159
+
160
#### Install Go
161
162
The build process for ipfs requires Go 1.12 or higher. If you don't have it: [Download Go 1.12+](https://golang.org/dl/).
@@ -171,6 +179,8 @@ $ cd go-ipfs
179
$ make install
180
```
181
182
+Alternatively, you can run `make build` to build the go-ipfs binary (storing it in `cmd/ipfs/ipfs`) without installing it.
183
+
184
#### Troubleshooting
185
186
- Separate [instructions are available for building on Windows](docs/windows.md).