docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improved installation docs

This commit is contained in:
James Turnbull 2014-08-02 07:40:13 -04:00
parent 8ca1d40f38
commit 280fa01612
1 changed files with 29 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -25,19 +25,43 @@ Here are some examples of what you can do with libswarm:
## Installation
First get the go dependencies:
You can install `libswarm` in a few simple steps. You will need to make
Go installed on your host.
1. Download the current source code.
```sh
go get github.com/docker/libswarm/...
go get github.com/docker/libswarm
```
Then you can compile `swarmd` with:
2. Make sure `$GOPATH/bin` is in your `$PATH`
```sh
export PATH=$GOPATH/bin:$PATH
```
3. Download or update the current dependencies.
```sh
cd $GOPATH/src/github.com/docker/libswarm
make deps
```
NOTE: You may also need `bzr`. On OS X, you can install it from
[here](http://wiki.bazaar.canonical.com/MacOSXDownloads) or via Home
Brew: `brew install bzr`. On Debian & Ubuntu, `apt-get install bzr` and
on Red Hat et al, `yum install bzr`.
4. Then compile `swarmd` with:
```sh
go install github.com/docker/libswarm/swarmd
```
If `$GOPATH/bin` is in your `PATH`, you can invoke `swarmd` from the CLI.
## Running libswarm
If `$GOPATH/bin` is in your `PATH`, you can invoke `swarmd` from the
command line.
```sh
$ swarmd -h