mirror of
https://github.com/HowestDAE/dae16-VerhulstBram.git
synced 2025-12-16 12:41:48 +01:00
164 lines
3.6 KiB
Markdown
164 lines
3.6 KiB
Markdown
<a name="readme-top"></a>
|
|
|
|
<!-- GENERAL GAME INFO -->
|
|
<br />
|
|
<div align="center">
|
|
|
|
<h1 align="center">NAME OF CHOSEN GAME</h1>
|
|
|
|
<p align="center">
|
|
Short description of the game.
|
|
<br />
|
|
<strong>Original game : </strong>
|
|
<a href="https://www.google.be/"><strong>General info »</strong></a>
|
|
·
|
|
<a href="https://www.google.be/"><strong>Youtube video »<strong></a>
|
|
<br />
|
|
<br />
|
|
</p>
|
|
</div>
|
|
|
|
|
|
|
|
<!-- TABLE OF CONTENTS -->
|
|
<details>
|
|
<summary>Table of Contents</summary>
|
|
<ol>
|
|
<li>
|
|
<a href="#about-the-project">About The Project</a>
|
|
</li>
|
|
<li>
|
|
<a href="#my-version">My version</a>
|
|
</li>
|
|
<li>
|
|
<a href="#getting-started">Getting Started</a>
|
|
</li>
|
|
<li><a href="#how-to-play">How To Play</a></li>
|
|
<li><a href="#class-structure">Class structure</a></li>
|
|
<li><a href="#checklist">Checklist</a></li>
|
|
<li><a href="#contact">Contact</a></li>
|
|
<li><a href="#acknowledgments">Acknowledgments</a></li>
|
|
</ol>
|
|
</details>
|
|
|
|
|
|
|
|
<!-- ABOUT THE PROJECT -->
|
|
## About The Project
|
|
|
|
TODO: add screenshot
|
|
|
|
Here's why:
|
|
TODO: describe why you chose this game
|
|
* reason 1
|
|
* reason ..
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
|
|
## My version
|
|
|
|
This section gives a clear and detailed overview of which parts of the original game I planned to make.
|
|
|
|
### The minimum I will most certainly develop:
|
|
* ..
|
|
* ..
|
|
|
|
### What I will probably make as well:
|
|
* ..
|
|
* ..
|
|
|
|
### What I plan to create if I have enough time left:
|
|
* ..
|
|
* ..
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
|
|
<!-- GETTING STARTED -->
|
|
## Getting Started
|
|
Detailed instructions on how to run your game project are in this section.
|
|
|
|
### Prerequisites
|
|
|
|
This is an example of how to list things you need to use the software and how to install them.
|
|
* Visual Studio 2022
|
|
|
|
### How to run the project
|
|
|
|
Explain which project (version) must be run.
|
|
* any extra steps if required
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
|
|
|
|
<!-- HOW TO PLAY -->
|
|
## How to play
|
|
|
|
Use this space to show useful examples of how a game can be played.
|
|
Additional screenshots and demos work well in this space.
|
|
|
|
### Controls
|
|
* keys, ..
|
|
* ..
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
|
|
|
|
<!-- CLASS STRUCTURE -->
|
|
## Class structure
|
|
|
|
### Object composition
|
|
If you applied object composition (optional); explain where and how.
|
|
|
|
### Inheritance
|
|
Explain where you applied inheritance (mandatory).
|
|
|
|
### ..
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
|
|
<!-- CHECKLIST -->
|
|
## Checklist
|
|
|
|
- [x] Accept / set up github project
|
|
- [ ] week 01 topics applied
|
|
- [ ] const keyword applied proactively (variables, functions,..)
|
|
- [ ] static keyword applied proactively (class variables, static functions,..)
|
|
- [ ] object composition (optional)
|
|
- [ ] week 02 topics applied
|
|
- [ ] week 03 topics applied
|
|
- [ ] week 04 topics applied
|
|
- [ ] week 05 topics applied
|
|
- [ ] week 06 topics applied
|
|
- [ ] week 07 topics applied
|
|
- [ ] week 08 topics applied
|
|
- [ ] week 09 topics applied (optional)
|
|
- [ ] week 10 topics applied (optional)
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
<!-- CONTACT -->
|
|
## Contact
|
|
|
|
Your Name - email@student.howest.be
|
|
|
|
Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
|
|
<!-- ACKNOWLEDGMENTS -->
|
|
## Acknowledgments
|
|
|
|
Use this space to list resources you find helpful and would like to give credit to.
|
|
|
|
* [Example 1: cpp reference on std::vector](https://en.cppreference.com/w/cpp/container/vector)
|
|
* ..
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|