Unverified Commit 373a49f4 authored by Steven Allen's avatar Steven Allen Committed by GitHub

Merge pull request #6338 from djdv/docs/unsupported

docs+mk: update guidance for unsupported platforms
parents 6ee4b0e7 fa479f7a
......@@ -138,12 +138,15 @@ $ cd go-ipfs
$ make install
```
If you are building on FreeBSD instead of `make install` use `gmake install`.
If you are building on a non-GNU system, use `gmake` in place of `make`.
Unsupported platforms (run `(g)make supported` for a list) will also need to set the `nofuse` gotag during build.
```
$ GOTAGS=nofuse (g)make install
```
#### Troubleshooting
- Separate [instructions are available for building on Windows](docs/windows.md).
- Also, [instructions for OpenBSD](docs/openbsd.md).
- `git` is required in order for `go get` to fetch all dependencies.
- Package managers often contain out-of-date `golang` packages.
Ensure that `go version` reports at least 1.10. See above for how to install go.
......
......@@ -108,6 +108,11 @@ uninstall:
$(GOCC) clean -i ./cmd/ipfs
.PHONY: uninstall
supported:
@echo "Currently supported platforms:"
@for p in ${SUPPORTED_PLATFORMS}; do echo $$p; done
.PHONY: supported
help:
@echo 'DEPENDENCY TARGETS:'
@echo ''
......
# Building on OpenBSD
## Prepare your system
Make sure you have `git`, `go` and `gmake` installed on your system.
```
$ doas pkg_add -v git go gmake
```
## Prepare go environment
Make sure your gopath is set:
```
$ export GOPATH=~/go
$ echo "$GOPATH"
$ export PATH="$PATH:$GOPATH/bin"
```
## Build
The `install_unsupported` target works nicely for openbsd. This will install
`gx`, `gx-go` and run `go install -tags nofuse ./cmd/ipfs`.
```
$ go get -v -u -d github.com/ipfs/go-ipfs
$ cd $GOPATH/src/github.com/ipfs/go-ipfs
$ gmake install_unsupported
```
if everything went well, your ipfs binary should be ready at `$GOPATH/bin/ipfs`.
```
$ ipfs version
```
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