docs+mk: update guidance for unsupported platforms
License: MIT Signed-off-by: Dominic Della Valle <ddvpublic@gmail.com>
Dominic Della Valle committed
May 15, 2019 at 15:02 UTC
fa479f7a8a0abbc35b7dcffbed2d8853e42b364f
3 files changed
+10
-39
README.md
+5
-2
@@ -138,12 +138,15 @@ $ cd go-ipfs
138
$ make install
139
```
140
141
-If you are building on FreeBSD instead of `make install` use `gmake install`.
141
+If you are building on a non-GNU system, use `gmake` in place of `make`.
142
+Unsupported platforms (run `(g)make supported` for a list) will also need to set the `nofuse` gotag during build.
143
+```
144
+$ GOTAGS=nofuse (g)make install
145
+```
146
147
#### Troubleshooting
148
149
- Separate [instructions are available for building on Windows](docs/windows.md).
146
-- Also, [instructions for OpenBSD](docs/openbsd.md).
150
- `git` is required in order for `go get` to fetch all dependencies.
151
- Package managers often contain out-of-date `golang` packages.
152
Ensure that `go version` reports at least 1.10. See above for how to install go.
Rules.mk
+5
@@ -108,6 +108,11 @@ uninstall:
108
$(GOCC) clean -i ./cmd/ipfs
109
.PHONY: uninstall
110
111
+supported:
112
+ @echo "Currently supported platforms:"
113
+ @for p in ${SUPPORTED_PLATFORMS}; do echo $$p; done
114
+.PHONY: supported
115
+
116
help:
117
@echo 'DEPENDENCY TARGETS:'
118
@echo ''
docs/openbsd.md
deleted
-37
@@ -1,37 +0,0 @@
1
-# Building on OpenBSD
2
-
3
-## Prepare your system
4
-
5
-Make sure you have `git`, `go` and `gmake` installed on your system.
6
-
7
-```
8
-$ doas pkg_add -v git go gmake
9
-```
10
-
11
-## Prepare go environment
12
-
13
-Make sure your gopath is set:
14
-
15
-```
16
-$ export GOPATH=~/go
17
-$ echo "$GOPATH"
18
-$ export PATH="$PATH:$GOPATH/bin"
19
-```
20
-
21
-## Build
22
-
23
-The `install_unsupported` target works nicely for openbsd. This will install
24
-`gx`, `gx-go` and run `go install -tags nofuse ./cmd/ipfs`.
25
-
26
-```
27
-$ go get -v -u -d github.com/ipfs/go-ipfs
28
-
29
-$ cd $GOPATH/src/github.com/ipfs/go-ipfs
30
-$ gmake install_unsupported
31
-```
32
-
33
-if everything went well, your ipfs binary should be ready at `$GOPATH/bin/ipfs`.
34
-
35
-```
36
-$ ipfs version
37
-```