fimfic2epub/README.md
2016-08-14 20:31:28 +02:00

1.4 KiB

fimfic2epub

This is a tool to generate better EPUB ebooks from fimfiction stories. It's also a Chrome/Firefox extension, replacing the default EPUB download option with this tool.

Usage (browser extension)

You can download the Chome extension from Chrome Web Store.

Right now the addon is not available in Add-ons for Firefox, but it's fully compatible.

Installation & usage (command line)

You can install the tool by running npm install -g fimfic2epub. You can then run it with $ fimfic2epub <story id>. This will save the EPUB in the current working directory.

Example:

Download Tag Test by McPoodle
$ fimfic2epub 180690

Building

Make sure Node.js is installed. After you've cloned this repository, run npm install and npm run build to build it. This project uses gulp.

Development

Make sure gulp is installed.

When working on the code and testing it in a web browser as an extension, you can run gulp in watch mode: gulp watch. This will lint code and build it when you save. To build, just run gulp or npm run build. To lint, run gulp lint and to clean, run gulp clean.