q66 pushed a commit to branch master. http://git.enlightenment.org/tools/edocgen.git/commit/?id=174c099a9bb0e60c8ad922f44aa4d4b756d7041b
commit 174c099a9bb0e60c8ad922f44aa4d4b756d7041b Author: Daniel Kolesa <[email protected]> Date: Mon Dec 17 16:34:43 2018 +0100 update readme --- README-docgen.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README-docgen.md b/README-docgen.md index 9b501dd..8a2f1c1 100644 --- a/README-docgen.md +++ b/README-docgen.md @@ -1,9 +1,13 @@ -# docgen +# edocgen -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). +This is the EFL documentation generator. 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). +To generate documentation, you need a `dokuwiki` directory in the current +path (see `--help` for `gendoc.lua` for how to alter the path). Then run +the `gendoc.lua` script with `elua`, passing a path to eo files to it. +If you don't pass a path, system eo files are used. + +Generally it is recommended that you pass it `src/lib` from your EFL tree +and symlink your DokuWiki installation in the current path. \ No newline at end of file --
