docgen: add readme to doc generator

This commit is contained in:
Daniel Kolesa 2016-03-31 14:32:34 +01:00
parent ada2474acf
commit e12ecb1a98
1 changed files with 9 additions and 0 deletions

9
README.md Normal file
View File

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