Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 1.2 KB

README.org

File metadata and controls

31 lines (23 loc) · 1.2 KB

Catter

Simple terminal based text file reader written in Rust. Works similarly to GNU cat but is more focused on viewing text files with interactive scrolling functionality for longer files. Catter silently omits any non-text based file as to not clutter the output.

The project serves a purpose of giving me an opportunity to learn Rust language and other associated frameworks.

Installation

Requirements:

  • Rust/Cargo
    • You will need this to compile the program
  • Just
    • Repository contains a justfile that can be used to automate build and installation process.

You can build and install catter with this command. It will install to $HOME/.bin/ or $HOME/bin/ if the first isn’t present in your home directory.

just install

To remove catter use remove recipe.

just remove

Otherwise Just is optional.

Copyright

Copyright © 2022 Purrie Brightstar.

Licence GPLv2: GNU GPL version 2 https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html

This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.