From bc9a54317829c90714dabe2f452727d4022e626a Mon Sep 17 00:00:00 2001 From: Aitor Date: Mon, 20 Mar 2023 19:27:13 +0100 Subject: [PATCH] Create README.md --- README.md | 199 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 199 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d586ce2 --- /dev/null +++ b/README.md @@ -0,0 +1,199 @@ + + + + + + + + +[![Contributors][contributors-shield]][contributors-url] +[![Forks][forks-shield]][forks-url] +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] +[![MIT License][license-shield]][license-url] +[![LinkedIn][linkedin-shield]][linkedin-url] + + + + +
+
+ + Logo + + +

Nom Nom 2020

+ +

+ An awesome README template to jumpstart your projects! +
+ Explore the docs » +
+
+ View Demo + · + Report Bug + · + Request Feature +

+
+ + + + +
+ Table of Contents +
    +
  1. + About The Project + +
    2. +
  2. + Getting Started + +
    3. +
  3. Usage
    4. +
  4. Contributing
    5. +
  5. License
    6. +
  6. Contact
    7. +
  7. Acknowledgments
    8. +
+
+ + + + +## About The Project + +[![Product Name Screen Shot][product-screenshot]](https://example.com) + +This game was developed as a small university project in 2020 (wouldn't have guessed by the title huh :satisfied:). The mechanic is pretty simple: You control Alvaro, a guy in a tiny spaceship who wants to steal coins from different worlds. But the planets will defende themselves, avoid their shots! + +Game characteristics: +* Levels are inifinite and dificulty increases with each +* Option to save the game by pressing 's' +* There is a leaderboard with local game points + +

(back to top)

+ + + +### Built With + +The thing is built with: + +* ![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white) +* ![Visual Studio](https://img.shields.io/badge/Visual%20Studio-5C2D91.svg?style=for-the-badge&logo=visual-studio&logoColor=white) +* ![C](https://img.shields.io/badge/c-%2300599C.svg?style=for-the-badge&logo=c&logoColor=white) + +yep, that's it :blush: + +

(back to top)

+ + + + +## Getting Started +### Prerequisites + +You must have a Windows operating system to play this game. Unfortunately, we were too young and Linux-less when we did this, and we didn't know any better. + +### Installation + +To get a local copy up and running follow these simple example steps. + +1. Download and unzip the file _NomNom2020.zip_ +2. Place the newly created folder in any location you wish +3. Execute _Nom Nom 2020.exe_ +* OPTIONAL: you can create a shortcut to your Desktop for easy access to the game! + +4. Play! + +

(back to top)

+ + + + +## Contributing + +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". +Don't forget to give the project a star! Thanks again! + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + +

(back to top)

+ + + + +## License + +Distributed under the GNU General Public License v3.0. See `LICENSE` for more information. + +

(back to top)

+ + + + +## Contact + +Your Name - a.astorga.sdv@gmail.com + +Project Link: [https://github.com/AitorAstorga/Nom-Nom-2020](https://github.com/AitorAstorga/Nom-Nom-2020) + +

(back to top)

+ + + + +## Acknowledgments + +* [Choose an Open Source License](https://choosealicense.com) +* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) +* [Img Shields](https://shields.io) +* [markdown-badges](https://github.com/Ileriayo/markdown-badges#table-of-contents) +* [GitHub Pages](https://pages.github.com) + +

(back to top)

+ + + + + +[contributors-shield]: https://img.shields.io/github/contributors/AitorAstorga/Nom-Nom-2020.svg?style=for-the-badge +[contributors-url]: https://github.com/AitorAstorga/Nom-Nom-2020/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/AitorAstorga/Nom-Nom-2020.svg?style=for-the-badge +[forks-url]: https://github.com/AitorAstorga/Nom-Nom-2020/network/members +[stars-shield]: https://img.shields.io/github/stars/AitorAstorga/Nom-Nom-2020.svg?style=for-the-badge +[stars-url]: https://github.com/AitorAstorga/Nom-Nom-2020/stargazers +[issues-shield]: https://img.shields.io/github/issues/AitorAstorga/Nom-Nom-2020.svg?style=for-the-badge +[issues-url]: https://github.com/AitorAstorga/Nom-Nom-2020/issues +[license-shield]: https://img.shields.io/github/license/AitorAstorga/Nom-Nom-2020.svg?style=for-the-badge +[license-url]: https://github.com/AitorAstorga/Nom-Nom-2020/blob/master/LICENSE +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 +[linkedin-url]: https://linkedin.com/in/aitor-astorga-saez-de-vicuña + +[product-screenshot]: NomNom2020/img/menu.bmp