Short description about the project, what it does, how, why, ...
This is a template to create new projects for Game*. It is to be used more as a guide than as a convention, so feel free to modify it as you please.
In this section, explain more in details what the project is and the commands. Maybe mention if a particular game should be used.
Feel free to do a little table as below to explain the commands!
The mapping of the controls is done as follows:
| On the bike | Player 1 | Player 2 | Effect |
|---|---|---|---|
| Pedal | W | Up arrow | Accelerate |
| Left handlebar button | A | Left arrow | Turn left |
| Right handlebar button | D | Right arrow | Turn right |
| (soon) Brakes | S | Down arrow | Brake/Reverse |
| (soon) Special button | Space | Right Ctrl | Use nitro |
If you want to add a note, use:
ℹ️ Note! Something that may be useful or helpful for the reader.
If you want to add a warning, use:
⚠️ Warning! Very import thing that the reader should take particularly care of.
Skip to Usage if you want to know how to use.
-
Here, you should do a step-by-step guide on how to assemble the project from scratch.
-
Feel free to add a lot of details.
ℹ️ Note! And add notes for more details or insights.
- Of course, when possible, add schemes and pictures.
⚠️ Warning! You may know what you are doing; the reader may not. Add more details!
- Tables are particularly useful when dealing with electronics. Add the pinout!
| Wire | Goes on |
|---|---|
| VCC board | VCC line |
| GND board | GND line |
Please refer to the main code README.
... Or put directly informations here, it depends on your project, really.
Here you should write down everything that is to know for the player and the operator of the game, namely, once the project is ready to be used.
Particularly specify if a specific game shall be used.
If an operator is needed, add the following:
ℹ️ Note! This setup requires an operator to handle the menu.
-
Here, you should do a step-by-step guide on how to play the project.
-
Feel free to add a lot of details.
ℹ️ Note! And add notes for more details or insights.
- Of course, when possible, add pictures and screenshots.
⚠️ Warning! You may know what you are doing; the reader may not. Add more details!
Here is the time to add instructions on how to fix problems with the project that cannot get fixed by maintainers.
Basically if something can get broken and cannot get easily fix, add ways to bypass the problem, fix it temporarly, etc.