From 394cbe06c7275ce4fc9b5d71b3ca244f82632761 Mon Sep 17 00:00:00 2001 From: Dynamitos Date: Mon, 16 Mar 2020 13:36:38 +0100 Subject: [PATCH] Create README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a03784d --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# Seele +The Seele engine is intendent to be a general purpose 3D Engine, built from the ground up to enforce verbosity for modern APIs, +but keeping it simple to use, with lots of additional and optional parameters. + +## Getting started +The project is built using standard CMake 3.15, so that and a modern C++17 compiler should be the only prerequisites. + +Clone the repository and initialize the dependencies with `git submodule update --init --recursive` + +*SLang library hasn't been included in the automatic build yet, so you have to manually compile that project, found in external/slang*