docgen: add readme to doc generator
authorDaniel Kolesa <d.kolesa@osg.samsung.com>
Thu, 31 Mar 2016 13:32:34 +0000 (14:32 +0100)
committerDaniel Kolesa <d.kolesa@osg.samsung.com>
Thu, 12 May 2016 10:58:59 +0000 (11:58 +0100)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..9b501dd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# docgen
+
+This is the upcoming documentation generator for EFL. It takes documentation
+described in Eo files and turns it into a DokuWiki structure (with possibility
+of adapting it to other systems later on).
+
+Use the supplied build.sh script to generate. By default, it assumes that a
+directory called "dokuwiki" is present in the current directory, so symlink
+your dokuwiki setup into it (or change the path).