Skip to content
gintsgintsPublic

About

No description, website, or topics provided.

Resources

Stars

5 stars

Watchers

1 watching

Forks

Latest commit

 

History

121 Commits

Folders and files

Repository files navigation

build

TouchTyping learning app

Application to teach TouchTyping.

Letter introduction at keyboard: screenshot

Exercise with screen keyboard: screenshot

Project aim

Project aim is:

  • should inlcude visualisation of easy customizable keyboard
  • training content should be possible to adapt to many languages
  • training should include all steps from very begining of blind typing
  • training should be done step by step while introducing letters one by one

Installation

Download your platform's file from the latest release. Lessons are built in, so there is nothing else to install.

On macOS, open the disk image and drag Raiti to Applications. The app is not signed with an Apple certificate yet, so macOS refuses to open it until the quarantine flag is cleared:

xattr -dr com.apple.quarantine /Applications/Raiti.app

On Linux and Windows the download is the binary itself. Linux needs it marked executable:

chmod +x raiti-x86_64-unknown-linux-gnu

Custom lessons

Raiti reads its own lessons unless it finds a data directory, which it looks for in this order:

  1. next to config.yaml, which is ~/Library/Application Support/raiti on macOS, ~/.config/raiti on Linux and %APPDATA%\raiti on Windows
  2. next to the executable, where earlier releases kept it

The first directory that can be used replaces the built-in lessons completely, so copy the whole data directory before editing it rather than dropping single files in.

A directory is used only if index.yaml, the keyboard layout named in config.yaml and every lesson listed in the index are present and readable. If something is missing, Raiti says so on startup and carries on with the lessons it ships with.

Statuss

Project is in active development phase and lot of code is subject to change.

Project roadmap

Project is far from stable. For stable version we should implement:

  • basic keyboard graphical representation ✅︎
  • lesson configuration commands using yaml data files
    • show ilustrations on correct finger & body positions.
    • show key location ✅︎
    • show explanation text ✅︎
    • pictures of correct sitting and finger positions while typing ✅︎
    • one line exercise with and without Enter at end
    • entry training with and without backspace usage - partly
    • speed improvement exercises with speed measurement
  • full course on query keyboard in yaml files
  • lesson table of contents, to choose any lesson to work on - partly
  • save state for lessons ✅︎
  • version packaging ✅︎

Known issues

  • space key press is not recognized
  • while loading unfinished lesson at start (after exit), exercises not filled.

Run project

To run project you should have rust infrastructure set up. Then you can compile and run project using commend:

cargo run

Similar projects

https://www.typingstudy.com/

About

No description, website, or topics provided.

Resources

Stars

5 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages