summaryrefslogtreecommitdiff
path: root/README.md
blob: 3678ef93958c87e95ef1fede964bf329da622733 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# Honey Engine

This is a 3D game engine written in C. It is a personal project, so while *I* will probably
use it for some projects, I can't reccommend that others do the same unless you're ready
to really dig into the source code.

The demo code, especially, is **very** rough. I'm using it as a testing ground for the features
I'm cramming in as fast as I can, so please be aware that it is almost certainly not written
with anything approaching good style.

## Installation

The Honey engine requires

* OpenGL 3.3+
* GLFW3
* cglm
* assimp

To install:

```
cmake .
make
```

To build the documentation:

```
cd doc
doxygen
```