Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
add javadoc for soundActivated method

update features and add gif

remove java api mention in readme
  • Loading branch information
creme332 committed Dec 23, 2023
1 parent 2b3efb0 commit 117b390
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
![repository banner](design/banner.png)

# tizc
![Java](https://img.shields.io/badge/java-%23ED8B00.svg?logo=openjdk&logoColor=white)
![coverage](.github/badges/jacoco.svg)

# About
A minimal typing test built with Java.

![](design/design.excalidraw.png)
![GIF of typing test](tizc.gif)

## Features
- Data persistence across sessions
- Multiple customizations (mode, difficulty, sound effects, ...)
- Detailed statistics with a chart after each test
- Live errors, wpm, and accuracy displays
- Adjustable difficulty
- Typing sound effect
- Detailed statistics with a wpm chart after each test
- Model-View-Controller pattern
- Tested with JUnit
- JavaDoc documentation
Expand All @@ -20,7 +19,6 @@ A minimal typing test built with Java.
- Maven for build
- JUnit for testing
- AWT, Swing, and Flatlaf for GUI
- Java Preferences API to save user settings

## Installation

Expand Down Expand Up @@ -66,7 +64,6 @@ Click on the `Play` button and start typing when you are ready. As soon as you m
- [ ] Track worst keys typed
- [ ] Support for capital letters, punctuation, numbers.
- [ ] Use JPackage to convert .jar to .exe
- [ ] Add social preview banner to public repository settings
- [ ] Write tests for UI
- [ ] [Make UI responsive](https://www.youtube.com/watch?v=ZJsjlucSoXM&ab_channel=SIMPLECODE)

Expand Down
Binary file added tizc.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 117b390

Please sign in to comment.