From 0c728c235c81c050b7a96c9ea7783894a30f0ba1 Mon Sep 17 00:00:00 2001 From: Tornado Tech <54727692+Tornado-Technology@users.noreply.github.com> Date: Mon, 29 Jul 2024 18:21:55 +1000 Subject: [PATCH] Added About to README --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 96bb12e..c09f674 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,11 @@ -# Building +# About + +Hypercube is a game engine/framework inspired by RboustToolbox, for creating cross-platform desktop games, with a predominant approach in ECS. + +> [!NOTE] +> Checkout the [Documentation](https://github.com/technologists-team/hypercube/wiki) + +## Building ``` git clone https://github.com/Tornado-Technology/hypercube.git git submodule update --init --recursive @@ -7,5 +14,5 @@ dotnet tool restore dotnet run --configuration=Release --project=.\Hypercube.Example\ ``` -# License +## License All code for the repository is licensed under [MIT](https://github.com/Tornado-Technology/hypercube/blob/master/LICENSE).