From 970d6a89ae350d3383ffa1ca9e35a2104880bc37 Mon Sep 17 00:00:00 2001 From: Lauchmelder Date: Tue, 19 May 2020 13:19:33 +0200 Subject: [PATCH] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d0ad716..2d2e746 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # SDL Utility A wrapper for SDL2 to make development on quick, simple graphics applications easier. -![C/C++ CI](https://github.com/Lauchmelder23/SDLU/workflows/C/C++%20CI/badge.svg?branch=development) +![Build (Ubuntu)](https://github.com/Lauchmelder23/SDLU/workflows/Build%20(Ubuntu)/badge.svg) **This branch is not the final version yet. This version is missing a lot of the features planned for this library** @@ -16,10 +16,10 @@ Note: Under Linux, it might be necessary to install `libdbus-1-dev` in order for 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`) +4. Run `cmake-gui ..` or `ccmake ..` 5. Configure CMake and enable `ENABLE_EXAMPLE` 6. Click Generate -7. Exit ccmake and type `make` +7. Type `make` ## Documentation The source code is annotated with doxygen comments. Simply run doxygen on the SDLU directory to generate the documentation for this library. An example project can also be built (Set the `ENABLE_EXAMPLE` flag in CMake), which implements a simple program using the SDLU library.