IMPORTANT : this is a work in progress and very not ready at all, this readme is what the goal is, not the current state
Typing Instructor is a command-line application designed to help programmers improve their typing skills by practicing with real-world code examples. The motivation behind this project was to create a more engaging and productive way for programmers to enhance their typing speed and accuracy while working with actual code snippets.
To install the project, follow these steps:
- Clone the repository to your local machine.
- Navigate to the project directory.
- Run
makecommand to compile the project. - An executable called
typingInstructorwill be generated in the project directory.
To run the Typing Instructor, execute the following command in the terminal: ./typingInstructor
The application supports the following command-line options:
-v: Verbose output to stderr-h: Print the help message
For example, to run the application with verbose output: ./typingInstructor -v
The main screen of the application allows you to choose between different options:
- Instructor: Start the typing practice session by choosing a language
- Info: Display information about the application and how to type faster
- Settings: Adjust application settings
- Exit: Quit the application
During the typing practice session, the application will display a code snippet for you to type. Your progress and speed will be shown at the bottom of the screen.
- Download code examples from specified URLs
- Practice typing with real-world code snippets
- Track typing progress during practice sessions
- Customize application settings
If you would like to contribute to the project, please follow these guidelines:
- Fork the repository
- Create a new branch for your feature or bugfix
- Make your changes and commit them to your branch
- Submit a pull request for review
Currently, there are no tests available for the application. Contributions to create and document tests are highly appreciated.
This project is licensed under the MIT License.