readme: add notes on building for uncommon systems
License: MIT Signed-off-by: Jeromy <why@ipfs.io>
Jeromy committed
Aug 7, 2016 at 10:31 UTC
1581265c2ce706df91f714f8b71e676e38a3d4f2
1 file changed
+17
README.md
+17
@@ -101,6 +101,23 @@ Then install `go-ipfs` and its dependencies, including `gx` and `gx-go`:
101
$ make install
102
```
103
104
+#### Building on less common systems
105
+
106
+If your operating system isn't officially supported, but you still want to try
107
+building ipfs anyways (It should work fine in most cases). You can do the
108
+following:
109
+
110
+- install gx: `go get github.com/whyrusleeping/gx`
111
+- install gx-go: `go get github.com/whyrusleeping/gx-go`
112
+- fetch ipfs source: `go get -d github.com/ipfs/go-ipfs 2> /dev/null`
113
+- enter source directory: `cd $GOPATH/src/github.com/ipfs/go-ipfs`
114
+- install deps: `gx install`
115
+- install ipfs: `go install ./cmd/ipfs`
116
+
117
+Note: This process may break if gx or any of its dependencies break as `go get`
118
+will always select the latest code for every dependency, often resulting in
119
+mismatched APIs.
120
+
121
#### Troubleshooting
122
123
* Separate [instructions are available for building on Windows](docs/windows.md).