From d7e7322fddd4a8485bd3b08a22214d0b1153c686 Mon Sep 17 00:00:00 2001 From: srdusr Date: Fri, 8 Mar 2024 19:54:56 +0200 Subject: Improved README with a few added details and improved some of the formatting --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index a6cd81c..aad3b85 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # _Typerpunk_ -_Typerpunk_ is a simple typing game written in Rust, where players are challenged to type sentences as quickly as possible. The game calculates the player's typing speed in Words Per Minute (WPM) and time taken. +**_Typerpunk_** is a simple typing game written in Rust, where players are challenged to type sentences as quickly as possible. The game calculates the player's typing speed in Words Per Minute (WPM) and time taken. > NOTE: Game is still in early stages of development. Plenty of features will be implemented such as programming related minigames, difficulty/custom settings and multiplayer to name a few. There are also plans to make this into not just a "cmdline" game but also have a fully fledged website and desktop gui client as well. @@ -12,7 +12,7 @@ _Typerpunk_ is a simple typing game written in Rust, where players are challenge ## Installation -To play _typerpunk_, make sure you have Rust installed on your system. You can install Rust from [rustup.rs](https://rustup.rs/). +To play **_Typerpunk_**, make sure you have Rust installed on your system. You can install Rust from [rustup.rs](https://rustup.rs/). - Can also use this to quickly download rust: @@ -40,10 +40,10 @@ cargo run --release ## How to Play -- Run the executable in the directory it's in (usually in typerpunk/target/release/): +- Run the executable: ```bash -./typerpunk +./target/release/typerpunk ``` - Or put the executable into your path. Example: @@ -52,21 +52,21 @@ cargo run --release sudo cp target/release/typerpunk /usr/local/bin ``` -- Quick overview of the basics: +### Gameplay: -``` -The game starts with a main menu. -Press Enter to begin. -A random sentence will be shown. -Press Enter again and type the sentence as quickly and accurately as you can. -Each correct character typed will be shown in green. -Each incorrect character typed will be shown in red. -If you make a mistake, you can use Backspace to correct it. -Press Enter when you have finished typing the sentence. -The game will display your Words Per Minute (WPM) and time taken. -To play again, press Enter at the End screen. -To quit the game, press Esc at any time. -``` +When the game starts, you will see a main menu. +Press `Enter` to begin the typing challenge. +Random text will be shown and game will only start as soon as you start typing. +Press `Enter` when you have finished typing the sentence. +The game will display your Words Per Minute (WPM) and time taken. +To play again, press `Enter` at the End screen. +To quit the game, press `Esc` at any time. + +### Controls: + +`Enter`: Submit typed sentence or proceed in menus. +`Backspace`: Delete the last character. +`Esc`: Quit the game or go back to the main menu. ## Contributing -- cgit v1.2.3