diff --git a/README.md b/README.md index 52bd2d1..316b584 100644 --- a/README.md +++ b/README.md @@ -1 +1,29 @@ -# Light \ No newline at end of file +# Light +A 2D cross-platform game engine + +## Supported Graphics APIs +* OpenGL +* DirectX + +Will support: +* Vulkan +* Metal + +## Supported Operating Systems +* Windows + +Will support: +* Linux +* Mac + +## Getting Started +1. Run `git clone --recurse-submodules -j4 https://github.com/Light3039/Light` +2. Open BuildScripts folder and build the project (only supports vs2019 for the time being) +3. Use the Sandbox project (a Demo project will be added soon) + + +## Acknowledgments +Huge thanks to these people: +* [TheCherno](https://www.youtube.com/channel/UCQ-W1KE9EYfdxhL6S4twUNw) for teaching C++, OpenGL and GameEngine development +* [Chili](https://www.youtube.com/channel/UCsyHonfwHi4fLb2lkq0DEAA) for teaching DirectX +* [JoeyDeVriez](https://learnopengl.com/) for creating learnopengl.com