X-Git-Url: http://git.nikiroo.be/?p=fanfix.git;a=blobdiff_plain;f=README.md;h=92f592938ba8f287211cc78a4d2b20ee2be4f603;hp=f7ef8b0ac7e6e734048cfc8a55ab60c50be3ed0e;hb=a7d266e6616349169d03e93780fb656754089dd0;hpb=88c61acaefde66584074867bda371dbfbcd92ec2 diff --git a/README.md b/README.md index f7ef8b0..92f5929 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Fanfix -Fanfix is a small Java program able to download stories from some supported websites and render them offline. +Fanfix is a small Java program that can download stories from some supported websites and render them offline. 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 or LaTeX). @@ -34,9 +34,9 @@ We support a few file types for local story conversion (both as input and as out ## Supported platforms -Any platform with at lest Java 1.5 on it should be ok. +Any platform with at lest Java 1.6 on it should be ok. -If you have any problems to compile it with a supported Java version (1.4 won't work, but you may try to cross-compile; 1.8 had been tested and works), please contact me. +If you have any problems to compile it with a supported Java version (1.5 won't work, but you may try to cross-compile or change the Bundle.java class from the utilities; 1.6 and 1.8 have been tested and work), please contact me. ## Usage @@ -67,14 +67,14 @@ Some environment variables are recognized by the program: ```./configure.sh && make``` -You can also import the java sources into, say, [https://eclipse.org/](Eclipse), and create a runnable JAR file from there. +You can also import the java sources into, say, [Eclipse](https://eclipse.org/), and create a runnable JAR file from there. ### Dependant libraries (included) -- libs/nikiroo-utils-sources-0.9.2.jar: some shared utility functions I also use elsewhere -- [https://github.com/unbescape/unbescape](libs/unbescape-1.1.4-sources.jar): a nice library to escape/unescape a lot of text formats; I only use it for HTML +- libs/nikiroo-utils-sources.jar: some shared utility functions I also use elsewhere +- [libs/unbescape-sources.jar](https://github.com/unbescape/unbescape): a nice library to escape/unescape a lot of text formats; I only use it for HTML -Nothing else but Java 1.5+. +Nothing else but Java 1.6+. Note that calling ```make libs``` will export the libraries into the src/ directory. @@ -82,7 +82,6 @@ Note that calling ```make libs``` will export the libraries into the src/ direct Currently missing, but either in progress or planned: - A GUI (work in progress) -- A binary JAR release (and thus, version 1) - Some readers other than CLI (TUI, GUI) - Check if it can work on Android - French translation