Skip to content

Commit

Permalink
whitespace...
Browse files Browse the repository at this point in the history
License: MIT
Signed-off-by: Dominic Della Valle <[email protected]>
  • Loading branch information
djdv committed Feb 27, 2018
1 parent ddc0239 commit 078fb31
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions docs/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
![](https://ipfs.io/ipfs/QmccXW7JSZMVXidSc7tHsU6aktuaiV923q4yBGHUsdymYo/build.gif)

## Install Go

`go-ipfs` is built on Golang and thus depends on it for all building methods.
https://golang.org/doc/install
The `GOPATH` environment variable must be set as well.
Expand All @@ -11,16 +10,16 @@ https://golang.org/doc/code.html#GOPATH
## Choose the way you want to proceed
`go-ipfs` utilizes `make` to automate builds and testing, but can be built without it using only `git` and `go`.
No matter which section you choose, if you encounter issues, please see the [Troubleshooting](#troubleshooting) section.

Using `make`:
These sections cover setting up the build environment, each option is equally valid and differ only in their setup process. If you have no preference or special requirements, MSYS2 is recommended as the first choice.
[MSYS2→](#msys2)
[Cygwin→](#cygwin)

Using build tools manually:
This section assumes you have a working version of `go` and `git` already setup. You may want to build this way if your environment restricts installing additional software, or if you are intigrating IPFS into your own build system.
This section assumes you have a working version of `go` and `git` already setup. You may want to build this way if your environment restricts installing additional software, or if you are intigrating IPFS into your own build system.
[Minimal→](#minimal)


## MSYS2
1. Install msys2 (http://www.msys2.org)
2. Run the following inside a normal `cmd` prompt (Not the MSYS2 prompt, we only need MSYS2's tools).
Expand Down Expand Up @@ -55,7 +54,6 @@ This can be acheived with the `setx` command
SETX PATH %PATH%;\msys64\usr\bin
```


## Cygwin
1. Install Cygwin (https://www.cygwin.com)
2. During the install, select the following packages. (If you already have Cygwin installed, run the setup file again to install additional packages) A fresh install should look something like [this reference image](https://ipfs.io/ipfs/QmaYFSQa4iHDafcebiKjm1WwuKhosoXr45HPpfaeMbCRpb/cygwin%20-%20install.png).
Expand Down Expand Up @@ -131,11 +129,11 @@ go install -ldflags="-X "github.com/ipfs/go-ipfs/repo/config".CurrentCommit=%SHA
You can check that the ipfs output versions match with `go version` and `git rev-parse --short HEAD`, if `ipfs.exe` executes and everything matches, then building was successful.

## Troubleshooting
- Git auth
- Git auth
If you get authentication problems with Git, you might want to take a look at https://help.github.com/articles/caching-your-github-password-in-git/ and use the suggested solution:
`git config --global credential.helper wincred`

- Anything else
- Anything else
Please search <https://discuss.ipfs.io/> for any additional issues you encounter, if you can't find an existing resolution, feel free to make a post asking for help.

If you encounter a bug with `ipfs` itself (not related to building) please use the issue tracker to report it.

0 comments on commit 078fb31

Please sign in to comment.