From c7f0f779b1e9174ad883554d20db737f2c21e11e Mon Sep 17 00:00:00 2001 From: Christian Schwarz Date: Tue, 22 May 2018 17:39:06 +0200 Subject: [PATCH] doc: README.md: push mentioning of Go down to developer docs. --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bca53ad..770dfc4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # zrepl -zrepl is a ZFS filesystem backup & replication solution written in Go. +zrepl is a one-stop ZFS backup & replication solution. ## User Documentation @@ -32,7 +32,10 @@ Check out the *Coding Workflow* section below for details. ## 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