Commit a8bcecef authored by Steven Allen's avatar Steven Allen

doc(README): expand the build documentation

fixes #6704
parent 01b357a9
...@@ -149,6 +149,14 @@ PS> scoop install go-ipfs ...@@ -149,6 +149,14 @@ PS> scoop install go-ipfs
### Build from Source ### 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 #### 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/). 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 ...@@ -171,6 +179,8 @@ $ cd go-ipfs
$ make install $ make install
``` ```
Alternatively, you can run `make build` to build the go-ipfs binary (storing it in `cmd/ipfs/ipfs`) without installing it.
#### Troubleshooting #### Troubleshooting
- Separate [instructions are available for building on Windows](docs/windows.md). - Separate [instructions are available for building on Windows](docs/windows.md).
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment