Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 867 Bytes

README.md

File metadata and controls

25 lines (18 loc) · 867 Bytes

Doc-Tor

Did you ever wish to tell somebody on discord to just read the (Java-)docs while not being rude? Did you ever wish to point out some cool Java method or class or highlight specific parts of the documentation?
Then Doctor is for you :)

Doctor is best explained by a short demo:

doctor.mp4

Running Doctor

The Doctor jar file can be build using mvn package and just takes a single argument:

java -jar Doctor.jar <path to config file>

Most of the magic happens in the config file. You can see an example in src/main/resources/config.toml.