Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating README to explain different ways of running .exe #4

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,33 @@ 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:

If "Typing Tutor.exe" isn't working then the game can be compiled using any of the two ways:
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'```
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.

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:

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)}

Expand Down