X-Git-Url: http://git.nikiroo.be/?p=fanfix.git;a=blobdiff_plain;f=README.md;h=6acc3d17bc4c34042e8894edef844c13cd698148;hp=28598334b05e5bf62484cc9e9a8916e70fc63d14;hb=9c59820764e52d69c4248a2c38a8f4a42059d647;hpb=42375f55f77dd1bc6b1dfc482b8e8964a7b771f5 diff --git a/README.md b/README.md index 2859833..6acc3d1 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,34 @@ 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. +## Synopsis + +- ```fanfix``` --import [*URL*] +- ```fanfix``` --export [*id*] [*output_type*] [*target*] +- ```fanfix``` --convert [*URL*] [*output_type*] [*target*] (+info) +- ```fanfix``` --read [*id*] ([*chapter number*]) +- ```fanfix``` --read-url [*URL*] ([*chapter number*]) +- ```fanfix``` --search +- ```fanfix``` --search [*where*] [*keywords*] (page [*page*]) (item [*item*]) +- ```fanfix``` --tag +- ```fanfix``` --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*] +- ```fanfix``` --help + ## Description (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.) -TODO: new screenshots + TUI screenshots - ![Main GUI](screenshots/fanfix-1.3.2.png?raw=true "Main GUI") +A screenshots cgallery an 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...). To help organize your stories, it can also work as a local library so you can: @@ -20,9 +38,9 @@ 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 **by calling a native program to handle it** (though Fanfix can automatically process it into HTML so any browser can open it) +- 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) -## Supported websites +### Supported websites Currently, the following websites are supported: @@ -32,8 +50,9 @@ Currently, the following websites are supported: - https://e621.net/: a Furry website supporting comics, including MLP - https://sofurry.com/: same thing, but story-oriented - https://e-hentai.org/: done upon request (so, feel free to ask for more websites!) +- http://mangas-lecture-en-ligne.fr/: a website offering a lot of mangas (in French) -## A note about file support +### Support file types We support a few file types for local story conversion (both as input and as output): @@ -48,7 +67,7 @@ We support a few file types for local story conversion (both as input and as out - cbz: .cbz (collection of images) files, preferably created with Fanfix (but any .cbz file is supported, though without most of Fanfix metadata, obviously) - html: HTML files that you can open with any browser; note that it will create a directory structure with ```index.html``` as the main file -- we only support importing HTML files created by Fanfix -## Supported platforms +### Supported platforms Any platform with at lest Java 1.6 on it should be ok. @@ -56,11 +75,12 @@ It has been tested on Linux (Debian, Slackware, Ubuntu), MacOS X and Windows for If you have any problems to compile it with a supported Java version (1.6+), please contact us. -## Usage +## Options You can start the program in GUI mode (as in the screenshot on top): - ```java -jar fanfix.jar``` +- ```fanfix``` (if you used *make install*) The following arguments are also allowed: @@ -69,6 +89,10 @@ The following arguments are also allowed: - ```--convert [URL] [output_type] [target] (+info)```: convert the story at URL into target, and force-add the .info and cover if +info is passed - ```--read [id] ([chapter number])```: read the given story denoted by ID from the library - ```--read-url [URL] ([chapter number])```: convert on the fly and read the story at URL, without saving it +- ```--search```: list the supported websites (```where```) +- ```--search [where] [keywords] (page [page]) (item [item])```: search on the supported website and display the given results page of stories it found, or the story details if asked +- ```--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 @@ -77,7 +101,7 @@ The following arguments are also allowed: - ```--help```: display the available options - ```--version```: return the version of the program -### Environment variables +### Environment Some environment variables are recognized by the program: @@ -98,10 +122,16 @@ There are some unit tests you can run, too: ### Dependant libraries (included) -- 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/jexer-sources.jar](https://github.com/klamonte/jexer): a small library that offers TUI widgets -- [libs/jsoup-sources.jar](https://jsoup.org/): a library to parse HTML +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 + +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 Nothing else but Java 1.6+.