Giter VIP home page Giter VIP logo

freeread's Introduction

FreeRead

FreeRead is a Node.js script that allows you to download and read books from Project Gutenberg right in your terminal. It offers a unique and distraction-free reading experience.

Prerequisites

  • Node.js and npm (comes bundled with Node.js)
  • Calibre for the ebook-convert command-line tool

Installation

  1. Clone or download this repository to your local machine.

  2. Navigate to the root directory of the script in your terminal (the directory where the package.json file is located).

  3. Install the script's dependencies by running:

    npm install
  4. Ensure ebook-convert is installed and available in your terminal by running:

    ebook-convert --version

    This should print the version of ebook-convert if it's installed correctly.

    If not installed you can install using Homebrew (macOS).

    brew install calibre

Usage

Once everything is set up, you can run the script using the npm script commands defined in the package.json file:

  • To read in light mode, use:

    npm run read
  • To read in dark mode, use:

    npm run read:dark

These commands will present you with a list of books. Choose one to download and read.

In this first version of "FreeRead" there are only two books to choose from. Eventually there will the ability to search for books available for free on Project Gutenberg.

While reading, you can scroll through the book using the arrow keys or the space bar. To exit the book and the script, press q. Upon exiting, the script will delete the downloaded and generated files.

Troubleshooting

If you encounter issues:

  • Make sure you have the latest version of Node.js and npm installed. The script may not work properly with older versions.
  • Verify that you've installed all dependencies with npm install.
  • Check if ebook-convert is properly installed and available in your terminal.
  • If you still encounter problems, feel free to open an issue in this repository.

License

This project is licensed under the ISC License.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.