ougge/README.md

24 lines
943 B
Markdown

# OUGGE
A game engine or something, idk.
## Installation
1. Clone the repository.
```sh
git clone --recurse-submodules https://timerix.ddns.net:3322/Timerix/ougge.git
```
2. Install [cbuild](https://timerix.ddns.net:3322/Timerix/cbuild.git).
3. Install [SDL2](https://github.com/libsdl-org/SDL) and [SDL2_image](https://github.com/libsdl-org/SDL_image).
- On **Linux** install shared libraries from a package manager or compile them from source.
- On **Windows** download pre-built dll's from github releases and put them into `dependencies/precompiled/`.
4. Symlink SDL headers directory to `dependencies/include`.
```sh
cd ../ougge
ln -s SDL2_HEADERS_DIRECTORY_ABSOLUTE_PATH -T dependencies/include/SDL2
```
Location of the headers can be found by `pkg-config --cflags --libs sdl2`.
Mingw installs SDL2 headers to `/mingw64/include/SDL2`.
5. Compile the program
```sh
cbuild build_exec_dbg
```