https://github.com/sunsations/speed_read

speed_read: A simple terminal-based open source Spritz-alike
https://github.com/sunsations/speed_read

Last synced: 2 months ago
JSON representation

speed_read: A simple terminal-based open source Spritz-alike

• Host: GitHub
• URL: https://github.com/sunsations/speed_read
• Owner: sunsations
• License: mit
• Created: 2014-03-03T13:57:16.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2014-06-23T20:54:57.000Z (over 10 years ago)
• Last Synced: 2024-04-24T10:18:35.543Z (9 months ago)
• Language: Ruby
• Homepage:
• Size: 173 KB
• Stars: 59
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: History.txt
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-cli-apps - SpeedRead - Spritz-alike speedreader. (Entertainment / Books)
• fucking-awesome-cli-apps - SpeedRead - Spritz-alike speedreader. (Entertainment / Books)

README

        
# SpeedRead

[![Dependency Status](https://gemnasium.com/sunsations/speed_read.svg)](https://gemnasium.com/sunsations/speed_read)

A simple terminal-based open source Spritz-alike.

This is a yet simplistic implementation in ruby of [Pasky's Perl version](https://github.com/pasky/speedread).

## Installation

Add this line to your application's Gemfile:

    gem 'speed_read'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install speed_read

## Usage

speed_read reads from standard input. Thus, 

you can use the usual unix suspects.

    $ echo "one two tree" | speed_read

    $ speed_read < your_text_file.txt

    $ cat your_text_file.txt | speed_read

To set the words per minute use

    $ echo "one two tree" | speed_read -w 500

## Test

In order to test the gem locally, use:

    

    bundle exec rake test

## Contributing

1. Fork it ( http://github.com/sunsations/speed_read/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request