From 88c61acaefde66584074867bda371dbfbcd92ec2 Mon Sep 17 00:00:00 2001 From: Niki Roo Date: Sun, 12 Feb 2017 13:26:28 +0100 Subject: [PATCH] README update --- README.md | 103 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 60 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 39f7fb4..f7ef8b0 100644 --- a/README.md +++ b/README.md @@ -1,71 +1,88 @@ # Fanfix -A small program to download and convert fanfictions and comics from supported websites into offline files (epu, cbz...). +Fanfix is a small Java program able to download stories from some supported websites and render them offline. -It can either "convert" a website into a file, or import/export to/from its library. +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). + +To help organize your stories, it can also work as a local library. + +In this mode, you can: +- Import a story from its URL (or even another file) +- Export a story to a file (.epub or .cbz) +- Display a story from the local library + +## Supported websites + +Currently, the following websites are supported: +- http://FimFiction.net/: fan fictions devoted to the My Little Pony show +- http://Fanfiction.net/: fan fictions of many, many different universes, from TV shows to novels to games +- http://mangafox.me/: a well filled repository of mangas, or, as their website states: most popular manga scanlations read online for free at mangafox, as well as a close-knit community to chat and make friends +- https://e621.net/: a Furry website supporting comics, including MLP + +## A note about file support + +We support a few file types for local story conversion (both as input and as output): +- epub: .epub files created by this program (we do not support "all" .epub files, at least for now) +- text: local stories encoded in plain text format, with a few specific rules: + - the title must be on the first line + - the author (preceded by nothing, "by " or "©") must be on the second line, possibly with the publication date in parenthesis (i.e., "By Unknown (3rd October 1998)") + - chapters must be declared with "Chapter x" or "Chapter x: NAME OF THE CHAPTER", where "x" is the chapter number + - a description of the story must be given as chapter number 0 + - a cover image may be present with the same filename as the story, but a .png, .jpeg or .jpg extension +- info_text: contains the same information as the text format, but with a companion .info file to store some metadata (the .info file is supposed to be created by Fanfix or compatible with it) +- cbz: .cbz (collection of images) files, preferably created with Fanfix (but any .cbz file is supported, though without most of Fanfix metadata, obviously) ## Supported platforms Any platform with at lest Java 1.5 on it should be ok. -It was only tested on Linux up until now, though. - -If you have any problems to compile it on another platform or 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.4 won't work, but you may try to cross-compile; 1.8 had been tested and works), please contact me. ## Usage -- java -jar fanfix.jar --convert http://SOME_SUPPORTE_URL/ epub /home/niki/my-story.epub: will convert the story to EPUB -- java -jar fanfix.jar --import http://SOME_SUPPORTED_URL/ : will import the story into the local library -- java -jar fanfix.jar --export LUID CBZ /tmp/comix.cbz : will export the story from the local library -- java -jar fanfix.jar --list: will list the known stories and their LUIDs from the local library -- ... (calling the program without parameters will display the syntax) +You can start the program in CLI mode: +- ```java -jar fanfix.jar``` + +__TODO__: offer a GUI mode (work in progress) + +The following arguments are allowed: +- ```--import [URL]```: import the story at URL into the local library +- ```--export [id] [output_type] [target]```: export the story denoted by ID to the target file +- ```--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 denoted by ID, without saving it +- ```--list```: list the stories present in the library and their associated IDs +- ```--set-reader [reader type]```: set the reader type to CLI or LOCAL for this command +- ```--help```: display the available options ### Environment variables -- LANG=en java -jar fanfix.jar: force the language to English (the only one for now...) -- CONFIG_DIR=$HOME/.fanfix java -jar fanfix.jar: use the given directory as a config directory (and copy the default configuration if needed) -- NOUTF=1 java -jar fanfix.jar: try to fallback to non-unicode values when possible (can have an impact on the resulting files, not only on user messages) +Some environment variables are recognized by the program: +- ```LANG=en```: force the language to English (the only one for now...) +- ```CONFIG_DIR=$HOME/.fanfix```: use the given directory as a config directory (and copy the default configuration if needed) +- ```NOUTF=1```: try to fallback to non-unicode values when possible (can have an impact on the resulting files, not only on user messages) +- ```DEBUG=1```: force the DEBUG=true option of the configuration file (to show more information on errors) ## Compilation -./configure.sh && make +```./configure.sh && make``` -You can also import the java sources into, say, Eclipse, and create a runnable JAR file from there. -Just remember to unpak the 2 dependant libraries before (or "make libs" can do it). +You can also import the java sources into, say, [https://eclipse.org/](Eclipse), and create a runnable JAR file from there. ### Dependant libraries (included) -- libs/nikiroo-utils-sources-0.9.1.jar: some shared utility functions I also use elsewhere -- 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-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 Nothing else but Java 1.5+. -Note that calling "make libs" will export the libraries into the src/ directory. - -## Supported websites - -Currently, the following websites are supported: -- http://FimFiction.net/: Fanfictions devoted to the My Little Pony show -- http://Fanfiction.net/: Fan fictions of many, many different universes, from TV shows to novels to games. -- http://mangafox.me/: A well filled repository of mangas, or, as their website states: Most popular manga scanlations read online for free at mangafox, as well as a close-knit community to chat and make friends. -- https://e621.net/: Furry website supporting comics, including MLP - -We also support some other (file) types: -- epub: EPUB files created by this program (we do not support "all" EPUB files) -- text: Support class for local stories encoded in textual format, with a few rules : - - the title must be on the first line, - - the author (preceded by nothing, "by " or "©") must be on the second line, possibly with the publication date in parenthesis (i.e., "By Unknown (3rd October 1998)"), - - chapters must be declared with "Chapter x" or "Chapter x: NAME OF THE CHAPTER", where "x" is the chapter number, - - a description of the story must be given as chapter number 0, - - a cover image may be present with the same filename but a PNG, JPEG or JPG extension. -- info_text: Contains the same information as the TEXT format, but with a companion ".info" file to store some metadata -- cbz: CBZ (collection of images) files created with this program +Note that calling ```make libs``` will export the libraries into the src/ directory. ## TODO -- A nice README file -- A binary JAR release (and thus, versions) -- Improve the CLI reader -- Offer some other readers (TUI, GUI) +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 -- 2.27.0