diff --git a/README.md b/README.md index a68a651..ee6822b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,11 @@ # SDL Utility -A wrapper for SDL2 to make development on quick, simple graphics applications easier. \ No newline at end of file +A wrapper for SDL2 to make development on quick, simple graphics applications easier. + +## How to compile +1. Clone the development branch `git clone -b development https://github.com/Lauchmelder23/SDLU` +2. Clone the submodules `git submodule update --init` +3. Create a build directory and enter it `mkdir build`, `cd build` +4. Run `ccmake ..` (Install ccmake via `sudo apt install cmake-curses-gui`) +5. Configure CMake and enable `ENABLE_EXAMPLE` +6. Click Generate +7. Exit ccmake and type `make`