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*