129e69fb9aafc9246c4d0d521b7aa00fd4c01fcc
[fanfix.git] / README.md

English Français

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 - the TUI client Fanfix-jexer

Synopsis

Description

(If you are interested in the recent changes, please check the Changelog – note that starting from version 1.4.0, the changelog is checked at startup.)

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:

Supported websites

Currently, the following websites are supported:

Support file types

We support a few file types for local story conversion (both as input and as output):

Supported platforms

Any platform with at lest Java 1.6 on it should be ok.

It has been tested on Linux (Debian, Slackware, Ubuntu), MacOS X and Windows for now, but feel free to inform us if you try it on another system.

If you have any problems to compile it with a supported Java version (1.6+), please contact us.

Options

You can start the program in two ways:

The following arguments are allowed:

Environment

Some environment variables are recognized by the program:

Compilation

./configure.sh && make

You can also import the java sources into, say, Eclipse, and create a runnable JAR file from there.

There are some unit tests you can run, too:

./configure.sh && make build test run-test

If you run the unit tests, note that some flag files can impact them:

Note that test/CACHE can be kept, as it will contain all internet related files you need (if you allow URLs, run the test once which will populate the CACHE then go OFFLINE, it will still work).

The test files will be:

Dependant libraries (included)

Required:

Optional:

Submodules:

Nothing else but Java 1.6+.

Note that calling make libs will export the libraries into the src/ directory.

Author

Fanfix was written by Niki Roo niki@nikiroo.be