README for submodules

[fanfix.git] / README.md

diff --git a/README.md b/README.md
index 62c4303fd959e4c3a653e89352477b4337002c23..129e69fb9aafc9246c4d0d521b7aa00fd4c01fcc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,7 +4,11 @@ English [Français](README-fr.md)
 
 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 can be found [here](https://github.com/nikiroo/fanfix-swing/)
+## 🔴 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
 
@@ -73,12 +77,12 @@ If you have any problems to compile it with a supported Java version (1.6+), ple
 
 ## Options
 
-You can start the program in GUI mode (as in the screenshot on top):
+You can start the program in two ways:
 
 - ```java -jar fanfix.jar```
 - ```fanfix``` (if you used *make install*)
 
-The following arguments are also allowed:
+The following arguments are allowed:
 
 - ```--import [URL]```: import the story at URL into the local library
 - ```--export [id] [output_type] [target]```: export the story denoted by ID to the target file
@@ -134,15 +138,20 @@ The test files will be:
 
 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
 
 Optional:
 
 - [```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.