lauchmelder/SDLU
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Lauchmelder 2020-05-19 13:19:33 +02:00 committed by GitHub
parent d4369128c0
commit 970d6a89ae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -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.