Merge pull request #66 from SWENG-2023/dev

SWENG Awards Version

Author: kvnkarthik02

README.md

@@ -1,5 +1,170 @@
-# SWENG-WebGL-Project
-Repository containing code from the SWENG module for our project with Qualcomm where we use WebGL for game development. 
-
-
-Live version of this project can be found here: https://sweng2023.herokuapp.com/
+<a name="readme-top"></a>
+
+<!-- PROJECT LOGO -->
+<div align="center">
+  <a href="https://github.com/SWENG-2023/SWENG-WebGL-Project">
+    <img src="assets/snake_sprites/head_up.png" alt="Logo" width="80" height="80">
+  </a>
+
+<h3 align="center">Sweng-18 2D WebGL Game Library</h3>
+
+  <p align="center">
+    in collaboration with Qualcomm
+    <br />
+    <a href="https://sweng2023.herokuapp.com"><strong>Play »</strong></a>
+  </p>
+</div>
+
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+        <li><a href="#development-process">Development process</a></li>
+        <li><a href="#games">Games</a></li>
+      </ul>
+    </li>
+    <li><a href="#getting-started">Getting Started</a></li>
+    <li><a href="#basic-product-backlog">Basic Product Backlog</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#the-team">The Team</a></li>
+    <li><a href="#acknowledgments">Acknowledgments</a></li>
+  </ol>
+</details>
+
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+
+<div align="center">
+  <a href="https://github.com/SWENG-2023/SWENG-WebGL-Project">
+    <img src="demo/mainmenu.png" alt="main-menu">
+  </a>
+</div>
+<br />
+Welcome to SWENG Group 18's 2D WebGL Game Library repository! This project is a collaboration between a group of 9 Computer Science students from Trinity College and the telecommunications company, Qualcomm. We have created a collection of 2d WebGL games that run smoothly in your browser, featuring our game engine.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+### Built With
+
+* [![WebGL][Webgl.js]][webgl-url]
+* [![JavaScript][javascript.js]][javascript-url]
+* [![HTML5][HTML5.html]][html5-url]
+* [![CSS5][CSS.css]][css-url]
+
+
+
+### Development Process
+
+Throughout the development process, we've followed the sprint methodology, with weekly meetings with John O'Shea the Principal Software Engineer of Qualcomm, as well as our demonstrator. Our team also held weekly meetings to ensure smooth progress. We employed a Kanban board using GitHub Projects to stay organised. Throughout four sprints, we re-created two classic games.
+
+
+### Games
+
+* Snake: A classic game, see if you can beat our high scores!
+* Snake Pong: A classic pong game...but with Snakes!
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+No need for prerequisites and installation! To dive into our game library, simply click the logo above, click 'play' below the logo or visit our live game by clicking [here](https://sweng2023.herokuapp.com/)
+
+
+<!-- PRODUCT BACKLOG -->
+## Basic Product Backlog
+
+- [ ] Generate a game engine
+- [ ] Art and animations for game assets and sprites
+- [ ] Implement textures for game objects
+- [ ] Implement scoreboard
+- [ ] Implement 3d graphics
+- [ ] Implement sound effects/sound control
+- [ ] Implement settings, pause and the main menu
+- [ ] Implement 2d tranformations
+- [ ] Implement core game logic
+
+See the [kanban board](https://github.com/orgs/SWENG-2023/projects/1) for a list of tasks that have been/are being developed
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- CONTRIBUTING -->
+## Contributing
+
+As this is a SWENG project, it is not open source. However, we are always open to feedback to improve our work. Any feedback you give is **greatly appreciated**.
+
+
+<!-- THE TEAM -->
+## The Team
+
+### Team Lead
+
+[Karthink Venkatesh][karthik-url]: 3rd Year Integrated Computer Science Student
+
+### Programming Lead
+
+[Diarmuid McGonagle][diarmuid-url]: 3rd Year Computer Science & Business Student
+
+### UI/UX Lead
+
+[Victoria Emukperuo][vic-url]: 3rd Year Integrated Computer Science Student
+
+#### Programming Team
+[Henry Li][henry-url]: 2nd Year Integrated Computer Science Student
+
+[Robby Linson][robby-url]: 2nd Year Integrated Computer Science Student
+
+[Jason Liu][jason-url]: 2nd Year Computer Science & Business Student
+
+#### UI/UX Team
+[Liam Düro][liam-url]: 2nd Year Computer Science & Business Student
+
+[Seán Lawlor][sean-url]: 2nd Year Integrated Computer Science Student
+
+[Isioma Anonyai][isioma-url]: 2nd Year Computer Science & Business Student
+
+<br />
+Project Link: https://github.com/SWENG-2023/SWENG-WebGL-Project
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- ACKNOWLEDGMENTS -->
+## Acknowledgments
+
+We would like to extend our gratitude to John O'Shea and the rest of Qualcomm for their support and guidance throughout the development process. Additionally, we would like to thank our Software Engineering lecturer and demonstrators for their valuable input and encouragement.
+
+We hope you enjoy our games! Happy gaming! 🎮
+
+
+<!-- MARKDOWN LINKS & IMAGES -->
+[product-screenshot]: demo/mainmenu.png
+[Webgl.js]: https://img.shields.io/badge/WebGL-990000?logo=webgl&logoColor=white&style=for-the-badge
+[Webgl-url]: https://www.khronos.org/webgl/wiki/Main_Page
+[HTML5.html]: https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white
+[HTML5-url]: https://html.spec.whatwg.org/multipage/
+[Javascript.js]: https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E
+[Javascript-url]:https://developer.mozilla.org/en-US/docs/Web/JavaScript
+[CSS.css]: https://img.shields.io/badge/css3-%231572B6.svg?style=fr-the-badge&logo=css3&logoColor=white
+[CSS-url]: https://developer.mozilla.org/en-US/docs/Web/CSS
+[vic-url]: https://github.com/vicky-emuk
+[karthik-url]: https://github.com/kvnkarthik02
+[diarmuid-url]: https://github.com/diarmuidmcg
+[henry-url]: https://github.com/yellowdragoon
+[robby-url]: https://github.com/Linsonr
+[liam-url]: https://github.com/liamDuero
+[isioma-url]: https://github.com/anonyaii
+[jason-url]: https://github.com/jathonderulo
+[sean-url]: https://github.com/seanl14
+