Car-Race-Game Tutorial

[KhushiLaddi08]

Description

This pull request aims to describe the car race game I build before with some new updates.

Contents

• The tutorial files is brief data of how to build the game as a new user with code. Each step and step information has been declared in the markdown files this listed changes also have one file where new user can have idea and make it by itself.

Additional Notes

This pull request basically focuses on brief information and list of changes asked.

[KhushiLaddi08]

Car Race Tutorial

[omckeon]

For all:

• Update the alt text for any images to properly explain what the image is showing.

For Step 1:

• Remove the "Environment Setup" section (not needed and includes mostly outdated information).
• It would be better to create a file tree diagram rather than the images, as these images are somewhat confusing.

Step 2:

• Some of the wording in the functions section is confusing (not sure if all of the dot points are relevant).
• Code indentation still needs to be fixed.
• What is the purpose of Step 2? Is it just to give information? (As is only covering cherry picked parts of the code it seems)
• What is the flowchart showing? (I can't see any relevant information here?)
• Step 2 seems better as a bit of an appendix rather than being part of the main tutorial guide.

Step 3:

• Mostly the same feedback as part 3 - these 2 steps should just be in appendix pages at the end.
• Flowchart also not adding anything to this either.

Step 4:

• This looks like a better place for the tutorial to start (with maybe a bit at the start for the program.cpp initial code like the game loop). And add the file setup mentioned for step 1 into the top of this step as well.
• Check the order of the information in this step so that you are starting with the struct and enum info, and then the functionality after.
• Also, I would suggest renaming this to something more like "Car Functionality" or similar.
• Flowchart can be removed as it doesn't add anything and is confusing.
• Add a "Final Car Code" section at the end with the entire "car.h" code, "car.cpp" code and "program.cpp" code (the file with the main function) in code blocks (1 for each).
• More context would be needed for an actual tutorial, but this looks to be more like a tutorial proposal, so just focus on updating the general outline/format.
• And move this folder into Tutorial proposals rather than Tutorials.

Step 5:

• The first part is called Game Initialisation, but is actually showing code for drawing the game? These are not the same thing. Initialisation is where you would create the variables in main...
• Missing the game_data struct information as well.
• And then mostly same feedback as Step 4.

Step 6:

• This is more of an appendix "How to Play" page.
• Update the file name to something more relevant.
• Remove the flowchart.

Step 7:

• Remove the flowchart.
• This is definitely just "Tutorial Proposal" style, as the format would need updating to read like a proper tutorial, but it seems to include all the information for someone else to use in a future trimester, so just add a "Final Code" section at the end with the entire code for all the different files in their own code block.