Updating README file

[kohadocs.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..50b6ed8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+Koha Documentation
+==================
+
+This is the Koha Documentation Repository
+
+Documentation is generated with Sphinx.
+
+Setup
+-----
+
+> sudo apt-get install python3-sphinx  python3-sphinxcontrib.spelling 
+
+Outputing Docs
+--------------
+
+> cd en/
+
+### For HTML
+> make html
+
+### For HTML in a single page
+>  make singlehtml
+
+### For an epub
+>  make epub
+
+Other useful commands
+---------------------
+
+To find everything that you can do, you can just do
+> cd en/
+> make
+
+And it will list all the available options. Some useful ones are
+
+### Check spelling
+> make spelling
+
+### Check links in the documentation
+> make linkcheck
+
+### Generate .po files for translation
+> make gettext
+
+