Skip to content
This repository has been archived by the owner on Feb 15, 2018. It is now read-only.

Commit

Permalink
Add build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
fd0 committed May 12, 2015
1 parent 8b6ed2a commit 5bba993
Showing 1 changed file with 33 additions and 10 deletions.
43 changes: 33 additions & 10 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,39 @@ restic is a program that does backups right. The design goals are:

* *Free*: restic is free software and licensed under the [BSD 2-Clause License](https://github.com/restic/restic/blob/master/LICENSE)

Installation
============

restic is written in the Go programming language. At the moment, the only way to install restic on your system is to compile it from source. Please read the [Getting Started Guide](https://golang.org/doc/install) of Go if you need help installing Go. You need at least version 1.3.

In order to install restic, run the following commands:

export GOPATH=~/src/go
go get github.com/restic/restic/cmd/restic
$GOPATH/bin/restic --help
Building
========

restic is written in the Go programming language. At the moment, the only way to install restic on your system is to compile it from source. You need at least Go version 1.3.

In order to build restic, run `make` in the checked-out repository, afterwards you'll find the binary in the current directory:

$ make
[...]

$ ./restic --help
Usage:
restic [OPTIONS] <command>

Application Options:
-r, --repo= Repository directory to backup to/restore from

Help Options:
-h, --help Show this help message

Available commands:
backup save file/directory
cache manage cache
cat dump something
find find a file/directory
fsck check the repository
init create repository
key manage keys
list lists data
ls list files
restore restore a snapshot
snapshots show snapshots
version display version

Using restic
============
Expand Down

0 comments on commit 5bba993

Please sign in to comment.