extern/zrepl
1
0
Fork 0
mirror of https://github.com/zrepl/zrepl.git synced 2024-11-25 18:04:58 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: README.md: push mentioning of Go down to developer docs.

Browse Source
This commit is contained in:
Christian Schwarz 2018-05-22 17:39:06 +02:00
parent e6426db8da
commit c7f0f779b1
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -1,5 +1,5 @@
# zrepl # zrepl
zrepl is a ZFS filesystem backup & replication solution written in Go. zrepl is a one-stop ZFS backup & replication solution.
## User Documentation ## User Documentation
@ -32,7 +32,10 @@ Check out the *Coding Workflow* section below for details.
## Developer Documentation ## Developer Documentation
First, use `./lazy.sh devsetup` to install build dependencies and read `docs/installation.rst -> Compiling from Source`. zrepl is written in [Go](https://golang.org) and uses [`dep`](https://github.com/golang/dep) to manage dependencies.
The documentation is written in [ReStructured Text](http://docutils.sourceforge.net/rst.html) using the [Sphinx](https://www.sphinx-doc.org) framework.
To get started, run `./lazy.sh devsetup` to easily install build dependencies and read `docs/installation.rst -> Compiling from Source`.
### Overall Architecture ### Overall Architecture