Move documentation build instructions to the end, with a separate header

We want to start with the Go 1.5 dependency and build/checkout
instructions.

Also create a separate subsection, to match the future “Building
in/without a container” subsections
This commit is contained in:
Miloslav Trmač
2017-05-12 17:13:44 +02:00
parent 150eb5bf18
commit 7db0aab330

View File

@@ -103,11 +103,6 @@ you'll get an error. You can fix this by either logging in (via `docker login`)
Building Building
- -
To build the manual you will need go-md2man.
```sh
Debian$ sudo apt-get install go-md2man
Fedora$ sudo dnf install go-md2man
```
To build the `skopeo` binary you need at least Go 1.5 because it uses the latest `GO15VENDOREXPERIMENT` flag. Also, make sure to clone the repository in your `GOPATH` - otherwise compilation fails. To build the `skopeo` binary you need at least Go 1.5 because it uses the latest `GO15VENDOREXPERIMENT` flag. Also, make sure to clone the repository in your `GOPATH` - otherwise compilation fails.
```sh ```sh
$ git clone https://github.com/projectatomic/skopeo $GOPATH/src/github.com/projectatomic/skopeo $ git clone https://github.com/projectatomic/skopeo $GOPATH/src/github.com/projectatomic/skopeo
@@ -124,6 +119,18 @@ You may need to install additional development packages: `gpgme-devel` and `liba
```sh ```sh
$ sudo dnf install gpgme-devel libassuan-devel btrfs-progs-devel device-mapper-devel $ sudo dnf install gpgme-devel libassuan-devel btrfs-progs-devel device-mapper-devel
``` ```
### Building documentation
To build the manual you will need go-md2man.
```sh
Debian$ sudo apt-get install go-md2man
Fedora$ sudo dnf install go-md2man
```
Then
```sh
$ make docs
```
Installing Installing
- -
If you built from source: If you built from source: