X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=README.md;h=826aacb2acf5b971db72964d9a823cbe15300211;hb=9119671d3774c0b74ce8661b5262ff14e6bfb010;hp=6b6edbac07807d4ec4cf40bb3f060c1700b4d30d;hpb=71d72f342e245b8d3d1e65f1fcd6f0a285da2eb7;p=fanfix.git diff --git a/README.md b/README.md index 6b6edba..826aacb 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ 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-1.3.2.png?raw=true "Main GUI") @@ -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,7 +97,9 @@ Currently missing, but either in progress or planned: - [x] YiffStar - [ ] [Two Kinds](http://twokinds.keenspot.com/) - [ ] [Slightly damned](http://www.sdamned.com/) -- [ ] A GUI (work in progress) + - [ ] Others? Any ideas? + - [x] [e-Hentai](https://e-hentai.org/) requested +- [x] A GUI (work in progress) - [x] Make one - [x] Make it run when no args passed - [x] Fix the UI, it is ugly @@ -103,8 +109,14 @@ Currently missing, but either in progress or planned: - [x] Show a list of types - [x] ..in the menu - [x] ..as a screen view - - [ ] options screen + - [x] options screen - [ ] A TUI reader + - [x] Choose an output (Jexer) + - [x] Implement it from --set-reader to the actual window + - [x] List the stories + - [ ] Fix the UI layout + - [ ] Status bar and real menus + - [ ] Open a story in the reader and/or natively - [ ] Check if it can work on Android - [x] First checks: it should work, but with changes - [ ] Adapt work on images :( @@ -122,8 +134,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