Fanfix is a small Java program that can download stories from some supported websites and render them offline.
-## 🔴 This is the command line and server program -- the graphical client is called [Fanfix-swing](https://github.com/nikiroo/fanfix-swing/) and the TUI client is [Fanfix-jexer](https://github.com/nikiroo/fanfix-jexer/)
+## 🔴 This is the command line and server program
+
+You can also use:
+- the graphical client [Fanfix-swing](https://github.com/nikiroo/fanfix-swing/)
+- the TUI client [Fanfix-jexer](https://github.com/nikiroo/fanfix-jexer/)
## Synopsis
Required:
-- ```libs/nikiroo-utils-sources.jar```: some shared utility functions
- [```libs/unbescape-sources.jar```](https://github.com/unbescape/unbescape): a nice library to escape/unescape a lot of text formats; used here for HTML
- [```libs/jsoup-sources.jar```](https://jsoup.org/): a library to parse HTML
- [```libs/JSON-java-20190722-sources.jar```](https://github.com/stleary/JSON-java): a library to parse JSON
- [```libs/jexer-sources.jar```](https://github.com/klamonte/jexer): a small library that offers TUI widgets
- [```pandoc```](http://pandoc.org/): to generate the man pages from the README files
+Submodules:
+
+- ```src/be/nikiroo/utils```: some shared utility functions from [https://github.com/nikiroo/nikiroo-utils.git](https://github.com/nikiroo/nikiroo-utils.git) -- branch ```subtree```
+- ```src/be/nikiroo/fanfix```: the main code on the same repository but on branch ```subtree```
+
Nothing else but Java 1.6+.
Note that calling ```make libs``` will export the libraries into the src/ directory.