diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..b7cd91093558b312f2186a10f3f34baf3944bf36 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Evyl +#### The ~~evil~~ Evyl Vulkan Library + +--- + +## cloning & building +```sh +# clone repository and step inside +git clone git@gitlab.fachschaften.org:smjlstor/evyl.git && cd evyl +# clone relevant submodules +git submodule update --init +# init vcpkg +./external/vcpkg/bootstrap-vcpkg.sh # optionally pass -disableMetrics to disable telemetry +# finally configure and build +mkdir build +cmake -B build -S . +cmake --build build +```