From dfb94290aee1611e64604f4acfac2f74dab067c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Brikou=20Carr=C3=A9?= Date: Fri, 3 Feb 2017 09:09:49 +0100 Subject: [PATCH 1/2] Add link to release page in doc --- README.md | 23 +++++++++++------------ doc/Manual.md | 29 +++++++++++++++-------------- 2 files changed, 26 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 86459354c..4460cdf5d 100644 --- a/README.md +++ b/README.md @@ -19,24 +19,23 @@ The latest documentation can be viewed online at a menu that allows switching to the documentation and user manual for the latest released version. -Build restic -============ +Install restic +============== -Install Go/Golang (at least version 1.6), then run `go run build.go`, -afterwards you'll find the binary in the current directory: +You can download the latest pre-compiled binary from the [restic release page](https://github.com/restic/restic/releases/latest). - $ go run build.go +```sh +$ ./restic --help +restic is a backup program which allows saving multiple revisions of files and +directories in an encrypted repository stored on different backends. - $ ./restic --help - Usage: - restic [OPTIONS] - [...] +Usage: + restic [command] +[...] +``` More documentation can be found in the [user manual](doc/Manual.md). -At the moment, the only tested compiler for restic is the official Go compiler. -Building restic with gccgo may work, but is not supported. - Contribute and Documentation ============================ diff --git a/doc/Manual.md b/doc/Manual.md index 0219a6aaf..a98f2d223 100644 --- a/doc/Manual.md +++ b/doc/Manual.md @@ -1,7 +1,13 @@ Thanks for using restic. This document will give you an overview of the basic functionality provided by restic. -# Building/installing restic +# Installing restic + +## from pre-compiled binary + +You can download the latest pre-compiled binary from the [restic release page](https://github.com/restic/restic/releases/latest). + +## Mac OS X If you are using Mac OS X, you can install restic using the [homebrew](http://brew.sh/) packet manager: @@ -11,25 +17,19 @@ $ brew tap restic/restic $ brew install restic ``` +## archlinux + On archlinux, there is a package called `restic-git` which can be installed from AUR, e.g. with `pacaur`: ```console $ pacaur -S restic-git ``` -At debian stable you can install 'go' directly from the repositories (as root): +# Building restic -```console -$ apt-get install golang-go -``` - -after installation of 'go' go straight forward to 'git clone [...]' - -If you are using Linux, BSD or Windows, the only way to install restic on your -system right now is to compile it from source. restic is written in the Go -programming language and you need at least Go version 1.6. Building restic may -also work with older versions of Go, but that's not supported. See the [Getting -started](https://golang.org/doc/install) guide of the Go project for +restic is written in the Go programming language and you need at least Go version 1.6. +Building restic may also work with older versions of Go, but that's not spported. +See the [Getting started](https://golang.org/doc/install) guide of the Go project for instructions how to install Go. In order to build restic from source, execute the following steps: @@ -46,6 +46,8 @@ $ go run build.go At the moment, the only tested compiler for restic is the official Go compiler. Building restic with gccgo may work, but is not supported. +# Usage help + Usage help is available: ```console @@ -352,7 +354,6 @@ enter password for repository: restoring to /tmp/restore-work ``` - # Manage repository keys The `key` command allows you to set multiple access keys or passwords per From 769a52df169e12b79bbe7bade4f422af9a26847e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Brikou=20Carr=C3=A9?= Date: Fri, 3 Feb 2017 10:41:54 +0100 Subject: [PATCH 2/2] Bring back "Build restic" paragraph --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4460cdf5d..b3292efb3 100644 --- a/README.md +++ b/README.md @@ -24,18 +24,24 @@ Install restic You can download the latest pre-compiled binary from the [restic release page](https://github.com/restic/restic/releases/latest). -```sh -$ ./restic --help -restic is a backup program which allows saving multiple revisions of files and -directories in an encrypted repository stored on different backends. +Build restic +============ -Usage: - restic [command] -[...] -``` +Install Go/Golang (at least version 1.6), then run `go run build.go`, +afterwards you'll find the binary in the current directory: + + $ go run build.go + + $ ./restic --help + Usage: + restic [OPTIONS] + [...] More documentation can be found in the [user manual](doc/Manual.md). +At the moment, the only tested compiler for restic is the official Go compiler. +Building restic with gccgo may work, but is not supported. + Contribute and Documentation ============================