diff --git a/README.md b/README.md index 5cb5940d0c2..2f137e8b7ff 100644 --- a/README.md +++ b/README.md @@ -149,6 +149,14 @@ PS> scoop install go-ipfs ### Build from Source +go-ipfs's build system requires Go 1.12 and some standard POSIX build tools: + +* GNU make +* Git +* GCC (or some other go compatible C Compiler) (optional) + +To build without GCC, build with `CGO_ENABLED=0` (e.g., `make build CGO_ENABLED=0`). + #### Install Go 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,10 @@ $ cd go-ipfs $ make install ``` +Alternatively, you can run `make build` to build the go-ipfs binary (storing it in `cmd/ipfs/ipfs`) without installing it. + +**NOTE:** If you get an error along the lines of "fatal error: stdlib.h: No such file or directory", you're missing a C compiler. Either re-run `make` with `CGO_ENABLED=0` or install GCC. + #### Troubleshooting - Separate [instructions are available for building on Windows](docs/windows.md).