1
0
mirror of https://github.com/zrepl/zrepl.git synced 2025-07-14 05:05:05 +02:00

docs: adjust README

This commit is contained in:
Christian Schwarz
2017-11-11 23:19:58 +01:00
parent 8cc31bd76a
commit ae4b12c9ba

@ -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