From 7df1c91a090d2ad78f668f1dba7cac48c9bbaeab Mon Sep 17 00:00:00 2001 From: Sebastian Thomschke Date: Mon, 27 Feb 2023 06:44:03 +0100 Subject: [PATCH] Update usage instructions. Fixes #296 (#306) --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fcbd767d..d862de14 100644 --- a/README.md +++ b/README.md @@ -31,8 +31,22 @@ haxelib install dox abstract rtti xml generation. You'll also need an up-to-date haxelib (requires support for `classPath` in _haxelib.json_) -1. Compile all relevant code with Haxe using `haxe -xml docs/doc.xml -D doc-gen`. -2. Invoke `haxelib run dox -i docs`, where dir points to the .xml file(s) generated by step 1. +1. Compile the code to be included in the documentation using: + ```sh + haxe -xml docs/doc.xml -D doc-gen [LIBS] + ``` + E.g. + ```sh + haxe -xml docs/doc.xml -D doc-gen --lib hxargs --classpath src -java bin my.aweseome.package + ``` +2. Generate the HTML pages using: + ```sh + haxelib run dox -i + ``` + ...where `input_dir` points to the directory containing the generated .xml file(s) of the previous step, i.e. + ```sh + haxelib run dox -i docs + ``` **:clipboard: For more details, custom theme creation and options [check out the Dox wiki](https://github.com/HaxeFoundation/dox/wiki/)**