mirror of
https://github.com/ipfs/kubo.git
synced 2025-06-30 09:59:13 +08:00
updated install instructions
- links to ipfs.io - links to gobuilder - better instructions License: MIT Signed-off-by: Juan Batiz-Benet <juan@benet.ai>
This commit is contained in:
32
README.md
32
README.md
@ -14,14 +14,39 @@ Please put all issues regarding go IPFS _implementation_ in [this repo](https://
|
||||
|
||||
## Install
|
||||
|
||||
[Download Go 1.4+](https://golang.org/dl/).
|
||||
The canonical download instructions for IPFS are over at: http://ipfs.io/doc/install
|
||||
|
||||
Setup PATH environment variable e.g., by adding these lines to your /etc/profile (for a system-wide installation) or $HOME/.profile:
|
||||
## 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)
|
||||
|
||||
From there:
|
||||
- click "Download" on the build for your platform
|
||||
- open/extract the archive
|
||||
- move `ipfs` to your path (`install.sh` can do it for you)
|
||||
|
||||
|
||||
## Build from Source
|
||||
|
||||
### Prerequisite: Install Go
|
||||
|
||||
First, you'll need go. If you don't have it: [Download Go 1.4+](https://golang.org/dl/).
|
||||
|
||||
You'll need to add Go's bin directories to your `$PATH` environment variable e.g., by adding these lines to your `/etc/profile` (for a system-wide installation) or `$HOME/.profile`:
|
||||
```
|
||||
export PATH=$PATH:/usr/local/go/bin
|
||||
export PATH=$PATH:$GOPATH/bin
|
||||
```
|
||||
|
||||
(If you run into trouble, see the [Go install instructions](http://golang.org/doc/install))
|
||||
|
||||
### Download + Compile IPFS
|
||||
|
||||
Then simply:
|
||||
|
||||
```
|
||||
@ -82,6 +107,9 @@ dependencies as well.
|
||||
```
|
||||
|
||||
## Getting Started
|
||||
|
||||
See also: http://ipfs.io/docs/getting-started/
|
||||
|
||||
To start using ipfs, you must first initialize ipfs's config files on your
|
||||
system, this is done with `ipfs init`. See `ipfs init --help` for information on
|
||||
the optional arguments it takes. After initialization is complete, you can use
|
||||
|
Reference in New Issue
Block a user