https://github.com/ismet55555/bieye
A blazingly fast rust-based bionic reader for blazingly fast reading within a terminal console 🦀
https://github.com/ismet55555/bieye
cli fast reading rust terminal
Last synced: 3 months ago
JSON representation
A blazingly fast rust-based bionic reader for blazingly fast reading within a terminal console 🦀
- Host: GitHub
- URL: https://github.com/ismet55555/bieye
- Owner: ismet55555
- Created: 2023-07-24T05:08:26.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-13T08:51:14.000Z (over 1 year ago)
- Last Synced: 2024-10-17T21:32:24.840Z (8 months ago)
- Topics: cli, fast, reading, rust, terminal
- Language: Rust
- Homepage:
- Size: 737 KB
- Stars: 16
- Watchers: 2
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This Rust-based CLI tool reads text and returns it back in bionic reading format
for blazingly fast loading and even faster reading!
Bionic reading is the reading of specially formatted text, allowing for
faster reading. This is possible by strategically highlinting pieces
of text, which tricks the brain of reading without losing content.
**Essentially:** Use this tool to speed up your text reading while using the console
## Installation
- **Homebrew**
```bash
brew install ismet55555/things/bieye
```
- **Snap Store**
```bash
snap install bieye
```
- **Cargo**
```bash
cargo install bieye
```
- **Compile From Source**
```bash
git clone [email protected]:ismet55555/bieye.git
cd bieye
cargo install --path .
```
## Usage Examples
The following are a few simple usage examples for `bieye`
```bash
# Simple text specification
bieye "Hello there, how is your day going?"
# Piping standard out into bieye
cat README.md | bieye
man git | bieye
echo "HELLO! hello hello elo el ..." | bieye
# Add some output options
cat quest.md | bieye --color --dim
```
## CLI Menu
```txt
$ bieye -h
bieye v0.0.0
This CLI tool reads text and returns it back in bionic reading format
for blazingly fast loading and even faster reading!
Example Usages:
bieye "Keep on reading"
echo "Read faster, learn more" | bieye --dim
man vim | bieye --dim --color
Usage: bieye [OPTIONS] [TEXT]
Arguments:
[TEXT] Capture text from stdin
Options:
-c, --color Color highlighted text
-d, --dim Dim text not highlighted
-h, --help Print help (see more with '--help')
-V, --version Print version
```
## Contribution and Development
Feel free to contribute! Here is a super quick start if you are vaguely familiar with [Rust](https://www.rust-lang.org/tools/install).
```bash
# Setup
git clone [email protected]:ismet55555/bieye.git
cd bieye
git checkout -b my-cool-new-branch
cargo build
# ... work work work ...
# Test run the CLI
cargo run -- --help
echo "Just some testing text" | cargo run --
# Run tests
cargo test
# Other terminal windows
cargo install --locked bacon
bacon --all-features
```