From f1f1b7a69d675bf0c2c8f286edb8dfd42a6af6ff Mon Sep 17 00:00:00 2001 From: stfm Date: Fri, 24 Nov 2017 09:30:14 +0100 Subject: [PATCH] update README.md --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0e26108..d6e1f53 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,9 @@ Example : -title "TeXDoclet Java Documentation" \ -author "Greg Wonderly \and S\"oren Caspersen \and Stefan Marx" \ -sourcepath src/main/java \ - -subpackages org + -subpackages org.stfm.texdoclet + +The most important is that you specify the Java packages (option `-subpackage`) and their location in the file system (option `-sourcepath`) correctly, otherwise no output is generated (specifying `-sourcepath` alone is not sufficient). See `createDocs.sh` scripts in `/examples` subdirectory for more examples. @@ -98,6 +100,10 @@ Calling `mvn javadoc:javadoc` creates `TeXDoclet.tex` (and `TeXDoclet.pdf`, see See `pom.xml` for example usage and more details about how to integrate *TeXDoclet* with maven `site:site` goal. Also check out [this example maven site project documentation](http://doclet.github.com/texdoclet/site). +Known issues +------------ + +If the `pdflatex` document compilation fails with a "TeX capacity exceeded, sorry ..." error message you better use the alternative command `lualatex` from the [LuaTeX project]. Previous versions -----------------