Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: improve build documentation #6706

Merged
merged 2 commits into from
Oct 8, 2019
Merged

README: improve build documentation #6706

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a8bcece
doc(README): expand the build documentation
Stebalien Oct 8, 2019
4a3a739
doc(README): call out the CGO build error
Stebalien Oct 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand All @@ -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).
Expand Down