X-Git-Url: http://git.nikiroo.be/?p=fanfix.git;a=blobdiff_plain;f=README.md;h=14e4347e185f7649478463d6aea0d00686c65801;hp=01f7419dd7d5ff6e7f35dddffe2dba08411308c3;hb=4f661b2bb0f64ed54c3e849c0c2c5b6bcfe844df;hpb=b2612f9dcd0a37f4ec22fcabe55390280e06daf2 diff --git a/README.md b/README.md index 01f7419..14e4347 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ Fanfix is a small Java program that can download stories from some supported websites and render them offline. -(If you are interested in the recent changes, please check the [Changelog](changelog.md).) +(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 (unless the option is disabled)) -![Main GUI](screenshots/fanfix.png?raw=true "Main GUI") +![Main GUI](screenshots/fanfix-1.3.2.png?raw=true "Main GUI") 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...). @@ -77,6 +77,10 @@ Some environment variables are recognized by the program: You can also import the java sources into, say, [Eclipse](https://eclipse.org/), and create a runnable JAR file from there. +There are some unit tests you can run, too: + +```./configure.sh && make build test run-test``` + ### Dependant libraries (included) - libs/nikiroo-utils-sources.jar: some shared utility functions I also use elsewhere @@ -93,6 +97,7 @@ Currently missing, but either in progress or planned: - [x] YiffStar - [ ] [Two Kinds](http://twokinds.keenspot.com/) - [ ] [Slightly damned](http://www.sdamned.com/) + - [ ] Others? Any ideas? - [ ] A GUI (work in progress) - [x] Make one - [x] Make it run when no args passed @@ -122,8 +127,8 @@ Currently missing, but either in progress or planned: - [x] in output classes (export) - [x] CLI usage of such - [x] GUI usage of such -- [ ] Version +- [x] Version - [x] Use a version number - [x] Show it in UI - - [ ] A check-update feature + - [x] A check-update feature