From ae4b12c9ba549a2ea884203bf200b7b9b2c81e74 Mon Sep 17 00:00:00 2001 From: Christian Schwarz Date: Sat, 11 Nov 2017 23:19:58 +0100 Subject: [PATCH] docs: adjust README --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 22454bd..8ac18ac 100644 --- a/README.md +++ b/README.md @@ -32,12 +32,11 @@ Make sure to develop an understanding how zrepl is typically used by studying th ``` ├── cmd │   ├── sampleconf # example configuration -├── docs -│   ├── content # hugo-based documentation -> sources for ./public_git -│   ├── deploy.sh # shell script for automated rendering & deploy to zrepl.github.io repo -│   ├── public_git # used by above shell script -│   └── themes -│   └── docdock # submodule of our docdock theme fork +├── docs # sphinx-based documentation +│   ├── **/*.rst # documentation in reStructuredText +│   ├── conf.py # sphinx configuration +│   ├── publish.sh # shell script for automated rendering & deploy to zrepl.github.io repo +│   ├── public_git # checkout of zrepl.github.io used by above shell script ├── jobrun # OBSOLETE ├── logger # logger package used by zrepl ├── rpc # rpc protocol implementation