bio-read 0.1.1

Bionic reading in terminal.
Documentation

bio-read

GitHub License GitHub Workflow Status GitHub Release GitHub Downloads (all assets, all releases) GitHub Downloads (all assets, latest release) Crates.io Version Crates.io Total Downloads

Bionic reading in terminal.

🚀 Installation

If you have cargo-binstall, you can install this tool by running:

cargo binstall bio-read

Otherwise, you can install it from source:

cargo install bio-read

📖 Usage

$ br --help
Usage: br [-f <fixation-point>] [-i <input>]

Bionic reading in terminal.

Options:
  -f, --fixation-point
                    the fixation point. Should be in range [1, 5]. Default is 3.
  -i, --input       the file to read from. Read from stdin if not specified.
  --help, help      display usage information

For simple usage, run br with the -i flag, which is a shorthand for --input:

$ br -i file.txt

Alternatively, pipe the text you want to read into br:

$ cat file.txt | br

To set fixation points, use the -f flag, which is a shorthand for --fixation-point:

$ cat file.txt | br -f 1