Home

Awesome

<img src="https://github.com/DriftingOtter/Typr/blob/main/assets/Typr_Astro.png" alt="Typr logo of an astronaut using a keyboard">

Typr: Your Personal Typing Tutor :keyboard:.

Description 📜

typr is a Python-based application that utilizes the 'rich' module to provide you with a simple yet satisfying tui when typing, typr is designed to be simple & easy to use; Whenever you want a simple but satisfying typing test tool.

asciicast

Installation Guide

  1. Check Python Version:

Ensure you have Python 3.8 or higher installed. If not, install it from the official Python website.

Quick Install

  1. Clone typr Repository:

Clone typr repository to your desired location.

git clone https://github.com/DriftingOtter/Typr.git

cd TyprCLI
  1. Run install script:
chmod +x install.sh

./install.sh

Manual Install // Manual Build

  1. Install rich Python module:

If you have not already done so, install the rich Python module, as it's a critical library for typr.

pip install rich
  1. Clone typr Repository:

Clone typr repository to your desired location using Git

git clone https://github.com/DriftingOtter/Typr.git

cd TyprCLI
  1. Locate main.py:

Make sure you know the correct path to your main.py file within the TyprCLI/src/ directory you just cloned.

  1. Set up Aliases (Optional)*

Please check with your shell's documentation on how to add aliases to your rc files.

Here are some commonly used shell alias commands you can copy.

Bash

Add the following line to your ~/.bashrc file:

alias typr="python3 /path/to/TyprCLI/src/main.py"

Zsh

Add the following line to your ~/.bashrc file:

alias typr="python3 /path/to/TyprCLI/src/main.py"

Fish

Add the following line to your ~/.config/fish/config.fish file:

alias typr="python3 /path/to/TyprCLI/src/main.py"

Xonsh

Add the following line to your ~/.xonshrc file:

aliases['typr'] = 'python3 /path/to/TyprCLI/src/main.py'
  1. Test The Alias

Open a new terminal window and type typr. It should execute your typr application.

You can also run typr -h to output the manual page for the application to see all the addional run-time flags you can utilize.

Contributing

If you want to contribute to this project, please feel free to read the CONTRIBUTING.md document to gain a better understanding of how to make changes, and improve this application.

Acknowledgements

(Image by catalyststuff on Freepik)