5 releases (3 stable)
1.0.2 | Jul 10, 2022 |
---|---|
1.0.1 | Jun 13, 2022 |
1.0.0 | Jun 8, 2022 |
0.2.1 | Jun 7, 2022 |
0.2.0 | Jun 7, 2022 |
#151 in #reading
45 downloads per month
10KB
141 lines
fsrx
📚(f)low (s)tate (r)eading e(x)change – flow state reading in the terminal
Inspired by (but not affiliated with) Renato Casutt and his revolutionary work on Bionic Reading.
Usage
For detailed usage run fsrx -h
.
fsrx 1.0.2
Colby Thomas <thatvegandev@gmail.com>
📚(f)low (s)tate (r)eading e(x)change
flow state reading in the terminal
USAGE:
fsrx [OPTIONS] [PATH]
ARGS:
<PATH> path to file (or supply input via stdin)
OPTIONS:
-c, --contrast high contrast
-f, --fixation <FIXATION> fixation intensity [default: m] [possible values: l, m, h]
-h, --help Print help information
-s, --saccade <SACCADE> saccade intensity [default: h] [possible values: l, m, h]
-V, --version Print version information
Examples
$ echo "the quick brown fox jumps over the lazy dog" | fsrx
$ fsrx input.txt | less
$ fmt -w60 input.txt | fsrx -c -fh -sl
Installation
Cargo
$ cargo install fsrx
Homebrew
incoming @ homebrew-fsrx
Arch Linux
fsrx
via the AUR
NetBSD
fsrx
from the official repositories
Contributing
All contributions are greatly appreciated. Please keep in mind this project is meant to be as lightweight as possible, so not every idea will be considered.
If you have a suggestion that would make fsrx better, please fork the
repo and create a pull
request. You can also
simply open an issue and select Feature Request
- Fork the repo
- Create your feature branch (
git checkout -b [your_username]/xyz
) - Commit your changes (
git commit -m 'add some xyz'
) - Rebase off main (
git fetch --all && git rebase origin/main
) - Push to your branch (
git push origin [your_username]/xyz
) - Fill out pull request template
See the open issues for a full list of proposed features (and known issues).
License
Distributed under the MIT License. See LICENSE.md for more information.
Follow
Dependencies
~5–7MB
~123K SLoC