Add README

Signed-off-by: George Melikov <mail@gmelikov.ru>
This commit is contained in:
George Melikov
2020-05-21 22:14:26 +03:00
parent 5536ff66c8
commit f68a6fd0f9

19
README.rst Normal file
View File

@@ -0,0 +1,19 @@
.. image:: docs/_static/img/logo/480px-Open-ZFS-Secondary-Logo-Colour-halfsize.png
OpenZFS Documentation
=====================
Public link: https://openzfs.github.io/openzfs-docs/
Local build
-----------
::
cd ./docs/
# install dependencies:
pip install -r requirements.txt
# run `sphinx` to build pages
make html
# html files will be generated in:
cd ./docs/_build/html/