Skip to content

Commit

Permalink
update README, remove redundant information
Browse files Browse the repository at this point in the history
  • Loading branch information
stfm committed Apr 12, 2022
1 parent 47cc95c commit 2591535
Showing 1 changed file with 1 addition and 7 deletions.
8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@ TeXDoclet

TeXDoclet is a Java doclet implementation that generates a LaTeX file from you Java code documentation.

The doclet is based on the doclet originally created by Greg Wonderly of
[C2 technologies Inc.](http://www.c2-tech.com>) and its revision by Soeren Caspersen of
[XO Software](http://www.xosoftware.dk).

See <http://doclet.github.com> for more information.

Build
-----

Expand Down Expand Up @@ -40,7 +34,7 @@ Example :
-sourcepath src/main/java \
-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).
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 will be generated (specifying `-sourcepath` alone is not sufficient).

See `createDocs.sh` scripts in `/examples` subdirectory for more examples.

Expand Down

0 comments on commit 2591535

Please sign in to comment.