X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=README.md;h=129e69fb9aafc9246c4d0d521b7aa00fd4c01fcc;hb=HEAD;hp=482d631e81fe84c19d455eba80efa9a294af3a4f;hpb=82f6ca779440a18f8fcfc74daa6c043ad28f07a0;p=fanfix.git diff --git a/README.md b/README.md index 482d631..129e69f 100644 --- 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 @@ -134,7 +138,6 @@ 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 @@ -144,6 +147,11 @@ 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.