Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

some fixes to the readme install instructions #2396

Merged
merged 3 commits into from
Feb 24, 2016
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 5 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,12 @@ The canonical download instructions for IPFS are over at: http://ipfs.io/docs/in

### Install prebuilt packages

We use [gobuilder.me](https://gobuilder.me), a great service that automatically builds a release on every commit.

You can see the latest builds for your platform at these links:

- [`release` - the last released version](https://gobuilder.me/github.com/ipfs/go-ipfs/cmd/ipfs?branch=release) **<-- recommended**
- [`master` - development, stable](https://gobuilder.me/github.com/ipfs/go-ipfs/cmd/ipfs?branch=master)
We host prebuilt binaries over at our [distributions page](https://dist.ipfs.io#go-ipfs).

From there:
- Click "Download" on the build for your platform.
- Click the blue "Download go-ipfs" on the right side of the page.
- Open/extract the archive.
- Move `ipfs` to your path (`install.sh` can do it for you),
- Move `ipfs` to your path (`install.sh` can do it for you).

### Build from Source

Expand All @@ -79,27 +74,20 @@ You can try using package manager, but gx and gx-go are unlikely to be available

#### Download + Compile IPFS

Then:
Simply run:

```
$ go get -d github.com/ipfs/go-ipfs
$ cd $GOPATH/src/github.com/ipfs/go-ipfs
$ make install
```

Tip:

If the `make install` hangs while fetching dependencies and if you are
running a daemon locally, ensure that it is on at least version 0.4.0-dev. If
you don't have a build that is new enough, run the `make install` with your
daemon turned off and the deps will be fetched through the ipfs.io gateways.

NOTES:

* `git` is required in order for `go get` to fetch
all dependencies.
* Package managers often contain out-of-date `golang` packages.
Compilation from source is recommended.
ensure that `go version` reports at least 1.5.2.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a line about how to ensure that, here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, i can say "see above on how to install go", will that work?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a command to update golang deps?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do you mean by golang deps?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nevermind. Saying "See above on how to install go" works.

* If you are interested in development, please install the development
dependencies as well.
* *WARNING: Older versions of OSX FUSE (for Mac OS X) can cause kernel panics when mounting!*
Expand Down