Skip to content

Commit

Permalink
Merge pull request #6413 from ipfs/doc/windows-build
Browse files Browse the repository at this point in the history
remove mentions of gx from windows build docs
  • Loading branch information
Stebalien authored Jun 6, 2019
2 parents f72ae26 + f6ea849 commit a9e1928
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 15 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,18 @@ With snap, in any of the [supported Linux distributions](https://snapcraft.io/do
$ sudo snap install ipfs
```

### From Windows package managers

- [Chocolatey](#chocolatey)

#### Chocolatey

The package [ipfs](https://chocolatey.org/packages/ipfs) currently points to go-ipfs and is being maintained.

```Powershell
PS> choco install ipfs
```

### Build from Source

#### Install Go
Expand Down
25 changes: 10 additions & 15 deletions docs/windows.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Building on Windows
![](https://ipfs.io/ipfs/QmccXW7JSZMVXidSc7tHsU6aktuaiV923q4yBGHUsdymYo/build.gif)

If you just want to install go-ipfs, please download it from https://dist.ipfs.io/#go-ipfs. This document explains how to build it from source.

## Install Go
`go-ipfs` is built on Golang and thus depends on it for all building methods.
https://golang.org/doc/install
Expand Down Expand Up @@ -103,27 +105,20 @@ SETX PATH %PATH%
```

## Minimal
While it's possible to build `go-ipfs` with `go` alone, we'll be using `git` and `gx` for practical source management.
You can use whichever version of `git` you wish but we recommend the Windows builds at <https://git-scm.com>. `git` must be in your [`PATH`](https://ss64.com/nt/path.html) for `go get` to recognize and use it.

### `gx`
You may install prebuilt binaries for [`gx`](https://dist.ipfs.io/#gx) & [`gx-go`](https://dist.ipfs.io/#gx-go) if they're available for your platform.
Alternatively, you can build them from source and install them to `%GOPATH%\bin` by running the following:
While it's possible to build `go-ipfs` with `go` alone, we'll be using `git` to fetch the source.

```
go get -u github.com/whyrusleeping/gx
go get -u github.com/whyrusleeping/gx-go
```
You can use whichever version of `git` you wish but we recommend the Windows builds at <https://git-scm.com>. `git` must be in your [`PATH`](https://ss64.com/nt/path.html) for `go get` to recognize and use it.

### go-ipfs

### `go-ipfs`
Clone and change directory to the source code, if you haven't already:

```
SET PATH=%PATH%;%GOPATH%\bin
go get -u -d github.com/ipfs/go-ipfs
cd %GOPATH%/src/github.com/ipfs/go-ipfs
gx --verbose install --global
cd cmd\ipfs
git clone https://github.com/ipfs/go-ipfs %GOPATH%/src/github.com/ipfs/go-ipfs
cd %GOPATH%/src/github.com/ipfs/go-ipfs/cmd/ipfs
```

We need the `git` commit hash to be included in our build so that in the extremely rare event a bug is found, we have a reference point later for tracking it. We'll ask `git` for it and store it in a variable. The syntax for the next command is different depending on whether you're using the interactive command line or writing a batch file. Use the one that applies to you.
- interactive: `FOR /F %V IN ('git rev-parse --short HEAD') do set SHA=%V`
- interpreter: `FOR /F %%V IN ('git rev-parse --short HEAD') do set SHA=%%V`
Expand Down

0 comments on commit a9e1928

Please sign in to comment.