Skip to content

Docs: Update README.md to Reflect Current Application State #68

@adithyen

Description

@adithyen

Is your feature request related to a problem? Please describe.
The current README.md is outdated and contains several inaccuracies when compared to the actual typing_speed_test.py code. This can confuse new contributors or users trying to run the project.

Specifically:

  1. Dependencies: The README states that only Python 3.x and Tkinter are required. However, the project uses customtkinter, darkdetect, and packaging (as seen in requirements.txt).
  2. Features listed: It claims there is an "Accuracy Check" and "Instant Feedback" with accuracy, but the current code only calculates WPM and does not measure accuracy.
  3. Gameplay Instructions: It says "Press Enter when you're done to see your results", but the app currently uses a "Check Result" button, and pressing Enter does nothing.
  4. Clone URL: https://github.com/your-username/typing-speed-test.git is a placeholder and should ideally point to the actual FOSSCLUB repository URL (https://github.com/FOSSCLUB-LBSITW/Typing-Test.git).

Describe the solution you'd like
Update the README.md to accurately reflect the application:

  1. Add instructions to install dependencies: pip install -r requirements.txt.
  2. Remove or correct the mention of "Accuracy Check".
  3. Correct the Gameplay Instructions to mention the "Check Result" button instead of the Enter key.
  4. Update the clone URL to the correct repository.

Describe alternatives you've considered
None, keeping documentation accurate is essential.

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions