Skip to content

Latest commit

 

History

History
163 lines (108 loc) · 5.92 KB

README.md

File metadata and controls

163 lines (108 loc) · 5.92 KB

Linux build macOS Build Windows build WebAssembly build Snap package

Contributors Forks Stargazers Issues MIT License


Logo

Open-Typer

Free and open source typing tutor
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License

About The Project

Open-Typer screenshot

Open-Typer is an open source typing tutor application which aims to make learning to touch type easier.

It supports multiple keyboard layouts and provides auto-generated lessons.

Open-Typer can be used on Windows, Linux and macOS.

(back to top)

Built With

(back to top)

Getting started

Building

Follow the instructions in the documentation.

Installation

Follow the instructions in the documentation.

(back to top)

Roadmap

See the open issues for a list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make Open-Typer better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin AmazingFeature)
  5. Open a Pull Request

To ensure that the code style is same in all C++ source files, please use clang-format:

sudo apt-get install clang-format (Debian/Ubuntu)

Run clang-format on all C++ source and header files you've changed:

clang-format -i app/src/*.cpp

Omitting this step will cause the checks in your pull request to fail.

(back to top)

License

Distributed under the GNU General Public License (version 3.0). See LICENSE for more information.

(back to top)