ttr: Practise Your Typing in Terminal

ttr is a simple, fast, and feature-rich typing trainer for the terminal.
It's built in Rust for high performance and offers a seamless, non-flickering typing experience directly in your command line.

Whether you want to practice with a specific text or just want a quick, randomized session, ttr has you covered.

✨ Features

• Blazing Fast: Built with Rust, it provides a smooth, low-latency typing experience.
• Dual Mode: Practice with text from any file or generate a random typing session.
• Real-time Feedback: Color-coded text shows your typing accuracy instantly.
• Detailed Stats: Get a summary of your performance, including time elapsed, WPM, and accuracy.

🚀 Installation

📦 Install from crates.io (recommended)

If you have Rust installed, you can install ttr directly with Cargo:

cargo install ttr

This will download, build, and place the binary in ~/.cargo/bin. Make sure that directory is in your PATH. ttr is easy to install if you have the Rust toolchain installed.

Run Locally

1. Clone the repository:

   git clone https://github.com/aashish-thapa/ttr.git
   cd ttr
   

2. Build the project in release mode:

   cargo build --release
   

3. Install the executable:

   sudo mv target/release/ttr /usr/local/bin/
   

   This moves the ttr binary to a directory in your system's PATH, making it accessible from anywhere.

💡 Usage

Run ttr from your terminal with or without an argument.

1. Random Typing Session

Run without arguments to generate a random set of common English words:

ttr

2. Practice with a Specific File

Provide the path to any .txt file you want to practice with:

ttr path/to/your/file.txt

3. Help and Version

Get more information about options:

ttr --help
ttr --version

🤝 Contributing

We welcome contributions! If you have an idea for a new feature or find a bug, please open an issue or submit a pull request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'feat: Add amazing feature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

🙏 Credits

Created by aashish-thapa.

Instruction is created using CHATGPT