Welcome to AWESOME PROJECT
AWESOME PROJECT is GDK (Graphics Development Kit) that provides core functionality to all of our Studio games and is responsible for the System I/O, Networking, and Licensing of those games. All of our games will require the use of AWESOME PROJECT to successfully integrate to our custom hardware and backend services.
Table of Contents
At any time, you can click the 
at the top-right of this document to view the Table of Contents.
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
What things you need to install the software and how to install them
Installation
A step by step series of examples that tell you how to get a development env running
Usage
Explain how to use your project for various use cases or scenarios
End with an example of getting some data out of the system or using it for a little demo
Setting up a development environment
Using Codespaces
AWESOME PROJECT has defined a Codespace development environment that uses a custom Docker image and provides a ready to deploy, instantaneous, VS Code environent. No configuration is necessary as it is all defined within the devcontainer.json file in this repository. All you have to do to start development is create a new Codespace in this repository and start coding.
Setting up your own dev environment
In order to develop locally, you can still run the above Codespace from your local copy of VS Code or Visual Studio, or you can create the environment on your own machine. To create your own environemnt you will want to:
- Pick the development tool of your choice and install it on your machine. AWESOME PROJECT can be developed with VS CODE or Visual Studio 2019 (and above)
- Install the prerequisites as described above
- Additionally, you will need to install
- Tool A
- Tool B
Running Tests
Explain how to run the automated tests for this system
Break down into end to end tests
Explain what these tests test and why
Deployment
Add additional notes about how to deploy this on a live system
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
License
This project is licensed under the GPL 3.0 license - see the LICENSE.md file for details
Contact
Your Name - your.email@example.com
For insight as to what the Core team is currenlty working on, please view our public backlog.
Project Link: Project Board
Acknowledgments
- Hat tip to anyone whose code was used
- Inspiration
- etc