Skip to content

Latest commit

 

History

History
51 lines (42 loc) · 3.14 KB

README.md

File metadata and controls

51 lines (42 loc) · 3.14 KB

⌨️ typr

typr is a Free and Open-Source program for typing speed improvement, remembering words. It's designed to be fast and lightweight, featuring Command Line Interface, written in C++ using curses library for GNU/Linux.

⚙️ customization

typr is customizable: words, colors, sizes.. To change the settings use command line by pressing colon :
Here is the list of all available commands:

name description
ldc or loadconfig Used to load/re-load config files
ldw or loadwords {name} Used to load/re-load words file, name parameter is optional, if not provided, will load latest loaded/saved file, if no files were used, defaults to "words"
svw or savewords {name} Used to overwrite save words file, similarly to ldw, if no argument given, picks latest used file or default
nw or newwords {name} Used to create a new empty wordset, optional name, similar to ldw, creating new words will erase all current words, don't forget to save!
addw or addwords {words...} Used to add new words to the list, optional number of arguments, duplicates are skipped
rmw or removewords {words...} Used to remove words from the list, optional number of arguments
ts or testsize {n} Used to change size of the test, in words
c or color {group} {r} {g} {b} Used to change color profiles for letters. Argument group is one of the 4 profiles:
  • typed or t: color of the correctly typed letters
  • error or e: color of the incorrectly typed letters
  • predicted or p: color of the letters to be typed
  • interface or i: color of the interface
{r}, {g} or {b} arguments are (red, green, blue) color components, in range 0 .. 1000
m or mode {mode} Used to change typing mode to one of the following:
  • relaxed or r: default mode, errors are highlighted
  • strict or s: hard mode, test ends on error
  • forgiving or f: light mode, ignores errors
r or reset Used to create new test

💾 persistent options

typrrc file contains persistent options and will be loaded by default on program start. typrrc consists of regular commands described above.
Here is an example of a typrrc, which (1) loads the words file, (2) sets the size of the test to be 50, (3) sets the colors:

ldw
testsize 50
color typed 950 950 950
color error 900 140 130
color predicted 500 500 600
color interface 950 950 950

Searching for all files in ~/.config/typr

🛠️ building

To build executable you can run make command in the typr directory. You can use the following command to download and build automatically:

git clone /~https://github.com/sgp729/typr.git && cd typr && make

📈 scalability

If you're a developer and want to bring your customization and individualization on a next level, you can create your own front-end for the app! Feel free to look at the base view class to inherit in your works.

Please report any issues encountered!