From 7991f68276da3e5a70459f16a65275b5aa3c1f5e Mon Sep 17 00:00:00 2001 From: Alexa <98698642+alexa-angelina@users.noreply.github.com> Date: Wed, 27 Sep 2023 21:10:51 -0400 Subject: [PATCH 1/3] Update README.md Added more detailed instructions for running the executable, specifically from within different IDE terminals. --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 84bb94c..62d583f 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,30 @@ It was made as a final project for my course Introduction to Computing CS101 dur ## How to Run -There's a file named "Typing Tutor.exe". Just run it and the game will start. +If you would like to run the .exe directly from the file explorer: + +Click the code dropdown and download the project folder. +Navigate to the download location and into the Code folder. +Right click on the "Typing Tutor.exe" file to run it. + +If you would like to work on and run the project within an IDE: + +Follow the same steps as previous to download the repository. +Open the project in your IDE. +Open a terminal window from within the Code folder. + +Powershell: +Typing ```.\Typing Tutor.exe``` will not work as the name has a space. +Instead, type the command "& '.\Typing Tutor.exe'" +A faster way to type this is to start with ```.\Typing``` and then press TAB. +The TAB will autocomplete the command for you to the command shown above. +It may autocomplete to ```& '.\Typing Tutor.cbp'```, so just replace the cbp with exe afterwards. + +Git Bash: +Git Bash does not recognize the ```&``` so you will just omit it to run the executable. +```'.\Typing Tutor.exe``` will start the game. +Note that TAB for autocomplete is not built into Git Bash. +If you would like to use autocomplete here, download the appropriate bash completion package. If "Typing Tutor.exe" isn't working then the game can be compiled using any of the two ways: From de24658ea88c4bb8865ca50c2f6420c73eb126fc Mon Sep 17 00:00:00 2001 From: Alexa <98698642+alexa-angelina@users.noreply.github.com> Date: Thu, 28 Sep 2023 12:28:59 -0400 Subject: [PATCH 2/3] Update README.md Fixed text not appearing as command snippet --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 62d583f..9f0929b 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Open a terminal window from within the Code folder. Powershell: Typing ```.\Typing Tutor.exe``` will not work as the name has a space. -Instead, type the command "& '.\Typing Tutor.exe'" +Instead, type the command ```& '.\Typing Tutor.exe'``` A faster way to type this is to start with ```.\Typing``` and then press TAB. The TAB will autocomplete the command for you to the command shown above. It may autocomplete to ```& '.\Typing Tutor.cbp'```, so just replace the cbp with exe afterwards. From df7400fb933d963736380527c5002d3d9ecfa31f Mon Sep 17 00:00:00 2001 From: Alexa <98698642+alexa-angelina@users.noreply.github.com> Date: Sat, 30 Sep 2023 10:13:13 -0400 Subject: [PATCH 3/3] Update README.md Changing header styles for clarity, explaining what ' ' does --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9f0929b..33decd9 100644 --- a/README.md +++ b/README.md @@ -21,13 +21,13 @@ It was made as a final project for my course Introduction to Computing CS101 dur ## How to Run -If you would like to run the .exe directly from the file explorer: +### If you would like to run the .exe directly from the file explorer: Click the code dropdown and download the project folder. Navigate to the download location and into the Code folder. Right click on the "Typing Tutor.exe" file to run it. -If you would like to work on and run the project within an IDE: +### If you would like to work on and run the project within an IDE: Follow the same steps as previous to download the repository. Open the project in your IDE. @@ -36,6 +36,7 @@ Open a terminal window from within the Code folder. Powershell: Typing ```.\Typing Tutor.exe``` will not work as the name has a space. Instead, type the command ```& '.\Typing Tutor.exe'``` +Adding the ```''``` around the file name ensures the entire string is read as the file name. A faster way to type this is to start with ```.\Typing``` and then press TAB. The TAB will autocomplete the command for you to the command shown above. It may autocomplete to ```& '.\Typing Tutor.cbp'```, so just replace the cbp with exe afterwards. @@ -46,7 +47,7 @@ Git Bash does not recognize the ```&``` so you will just omit it to run the exec Note that TAB for autocomplete is not built into Git Bash. If you would like to use autocomplete here, download the appropriate bash completion package. -If "Typing Tutor.exe" isn't working then the game can be compiled using any of the two ways: +### If "Typing Tutor.exe" isn't working then the game can be compiled using any of the two ways: 1) The project is compiled using Code Blocks. So, there is a file named "Typing Tutor.cbp". Open it in Code Blocks and the whole project will load up with all files. Then just click "Build and Run" and the game will start. {Add the libgdi32 library in Code Blocks using project->build options->linker settings-> add button (find libgdi32 for your compiler)}