English [Français](README-fr.md)
# Fanfix
+
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
+
+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
- ```fanfix``` --import [*URL*]
- ```fanfix``` --search-tag
- ```fanfix``` --search-tag [*index 1*]... (page [*page*]) (item [*item*])
- ```fanfix``` --list
-- ```fanfix``` --set-reader [*GUI* | *TUI* | *CLI*]
- ```fanfix``` --server [*key*] [*port*]
- ```fanfix``` --stop-server [*key*] [*port*]
- ```fanfix``` --remote [*key*] [*host*] [*port*]
(If you are interested in the recent changes, please check the [Changelog](changelog.md) -- note that starting from version 1.4.0, the changelog is checked at startup.)
-(A [TODO list](TODO.md) is also available to know what is expected to come in the future.)
-
-![Main GUI](screenshots/fanfix-1.3.2.png?raw=true "Main GUI")
-
-A screenshots gallery can be found [here](screenshots/README.md).
-
-It will convert from a (supported) URL to an .epub file for stories or a .cbz file for comics (a few other output types are also available, like Plain Text, LaTeX, HTML...).
+This program will convert from a (supported) URL to an .epub file for stories or a .cbz file for comics (a few other output types are also available, like Plain Text, LaTeX, HTML...).
To help organize your stories, it can also work as a local library so you can:
- Import a story from its URL (or just from a file)
- Export a story to a file (in any of the supported output types)
- Display a story from the local library in text format in the console
-- Display a story from the local library graphically **natively** or **by calling a native program to handle it** (potentially converted into HTML before hand, so any browser can open it)
+- Via [fanfix-swing](https://github.com/nikiroo/fanfix-swing/): Display a story from the local library graphically **by itself** ([fanfix-swing](https://github.com/nikiroo/fanfix-swing/)) or **by calling a native program to handle it** (potentially converted into HTML before hand, so any browser can open it)
### Supported websites
## 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
- ```--tag [where]```: list all the tags supported by this website
- ```--tag [index 1]... (page [page]) (item [item])```: search for the given stories or subtags, tag by tag, and display information about a specific page of results or about a specific item if requested
- ```--list```: list the stories present in the library and their associated IDs
-- ```--set-reader [reader type]```: set the reader type to CLI, TUI or GUI for this command
- ```--server [key] [port]```: start a story server on this port
- ```--stop-server [key] [port]```: stop the remote server running on this port (key must be set to the same value)
- ```--remote [key] [host] [port]```: contact this server instead of the usual library (key must be set to the same value)
- ```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: