diff options
| -rw-r--r-- | .gitignore | 10 | ||||
| -rw-r--r-- | CMakeLists.txt | 4 | ||||
| -rw-r--r-- | README.md | 44 |
3 files changed, 55 insertions, 3 deletions
@@ -1,2 +1,10 @@ .idea -cmake-build-debug +cmake-build* +build +dng +Makefile +.cmake +CMakeFiles +cmake_install.cmake +CMakeCache.txt +dng*
\ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt index f29faa3..f134e83 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,7 +1,7 @@ -cmake_minimum_required(VERSION 3.23) +cmake_minimum_required(VERSION 3.20) project(dng) -set(CMAKE_CXX_STANDARD 23) +set(CMAKE_CXX_STANDARD 20) find_package(Lua REQUIRED) diff --git a/README.md b/README.md new file mode 100644 index 0000000..7fde27a --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# dng + +## Develop + +### Dependencies + +Current build process is setup for a *nix like environment. + +| Dependency | Version | +| :---- |:--------| +| c++ | 20+ | +| g++ | 8+ | +| CMake | 3.20+ | +| Lua | 5.4.* | + +_Note: with some CMake modifications we could probably leverage lower versions_ + +### Build + +dng uses CMake + +```shell +# use a build dir to ensure we ignore build props +cmake -B cmake-build +``` + +_Developed with CLion using CMake and g++ on Linux_ + +## Run + +Once you build the project you can execute it by: + +```shell +# use your build dir and select a map! +./cmake-build/dng ./path/to/map/lvl +``` + +To launch level 1 for example: + +```shell +./cmake-build/dng ./maps/lvl1 +``` + +Note: You need to use the working directory containing the `include` folder! |