29
GitHub - nemanjan00/uniread: Uniread is Spritz like CLI fast reading software.
source link: https://github.com/nemanjan00/uniread
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
README.md
uniread
Uniread is Spritz like CLI fast reading software.
Content
Supported ebook types
We try to support as much as possible of ebook formats. If you have any kind of requests, feel free to create feature request in issues.
- epub (thanks to julien-c/epub library)
Installation
sudo npm install -g uniread
Usage
uniread ~/Books/somebook.epubDevelopers guide
Yarn package manager
For this project development, we are using faster, yarn package manager.
To install it, run:
sudo npm install -g yarn
After that, you need to install dependencies, using:
yarn
Getting sample books for testing
Books source: https://pressbooks.com/sample-books/
To download books, run
yarn get-books
Coding Style
Coding style of this project is defined inside .editorconfig and to use it, download Editor Config plugin for your text editor.
Linting
For linting, we are using eslinter and to run it, you can just use:
Testing
To run tests, we use mocha.
To run it, simply:
yarn test
yarn lint
Authors
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK