Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jrnxf/fsrx
📚 flow state reading in the terminal
https://github.com/jrnxf/fsrx
cli flow reading rust terminal
Last synced: 2 days ago
JSON representation
📚 flow state reading in the terminal
- Host: GitHub
- URL: https://github.com/jrnxf/fsrx
- Owner: jrnxf
- License: mit
- Created: 2022-06-04T04:13:44.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-07T14:29:51.000Z (12 months ago)
- Last Synced: 2025-01-15T04:37:25.185Z (9 days ago)
- Topics: cli, flow, reading, rust, terminal
- Language: Rust
- Homepage:
- Size: 168 KB
- Stars: 302
- Watchers: 3
- Forks: 8
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# fsrx
📚(**f**)low (**s**)tate (**r**)eading e(**x**)change – flow state
reading in the terminal
[](https://github.com/jrnxf/fsrx/actions/workflows/ci.yml)
[](https://github.com/jrnxf/fsrx/actions/workflows/deploy.yml)
[](./LICENSE.md)
[](https://crates.io/crates/fsrx)
[](https://github.com/jrnxf/fsrx/stargazers)
_Inspired by **(but not affiliated with)** Renato Casutt and his
revolutionary work on [Bionic Reading](https://bionic-reading.com)._
## Usage
For detailed usage run `fsrx -h`.
```
fsrx 1.0.2
Colby Thomas
📚(f)low (s)tate (r)eading e(x)change
flow state reading in the terminal
USAGE:
fsrx [OPTIONS] [PATH]
ARGS:
path to file (or supply input via stdin)
OPTIONS:
-c, --contrast high contrast
-f, --fixation fixation intensity [default: m] [possible values: l, m, h]
-h, --help Print help information
-s, --saccade saccade intensity [default: h] [possible values: l, m, h]
-V, --version Print version information
```
### Examples
```sh
$ 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
```sh
$ cargo install fsrx
```
### Homebrew
incoming @
[homebrew-fsrx](https://github.com/jrnxf/homebrew-fsrx)
### Arch Linux
`fsrx` via the AUR
### NetBSD
`fsrx` from the [official repositories](https://pkgsrc.se/textproc/fsrx)
## 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](https://github.com/jrnxf/fsrx/pulls). You can also
simply open an issue and select `Feature Request`
1. Fork the repo
2. Create your feature branch (`git checkout -b [your_username]/xyz`)
3. Commit your changes (`git commit -m 'add some xyz'`)
4. Rebase off main (`git fetch --all && git rebase origin/main`)
5. Push to your branch (`git push origin [your_username]/xyz`)
6. Fill out pull request template
See the [open issues](https://github.com/jrnxf/fsrx/issues) for
a full list of proposed features (and known issues).
## License
Distributed under the MIT License. See [LICENSE.md](./LICENSE.md) for
more information.
## Follow
[](https://github.com/jrnxf)
[](https://twitter.com/_jrnxf)
[](https://www.youtube.com/@jrnxf)