Add readme.md to project

This commit is contained in:
Doyle 2016-08-05 01:55:52 +10:00 committed by GitHub
parent db1eb7b9f3
commit f85ab5c86d

15
README.md Normal file
View File

@ -0,0 +1,15 @@
# Dengine
Dengine is a 2d game engine developed with OpenGL and low-level libraries in C. The main goal of Dengine is to facilitate learning from many aspects of Computer Science. Alongside Dengine a game is being built which guides the development of features for the game. Dengine is inspired by Handmade Hero, with a focus on developing as many features with minimal libraries, such that it is not too time-consuming and counter-productive to do so.
## Building
Dengine is currently being developed using Visual Studio 2015. You can build the project by executing the (preferred) **build.bat** in the src folder, or simply opening the project in Visual Studio and compiling.
Additionally, an OpenAL-Soft DLL is required which can be downloaded from the Window pre-built binaries of [OpenAL here.](http://kcat.strangesoft.net/openal.html)
NOTE: Assets are not included in the repository.
## Dependencies
- [GLEW](http://glew.sourceforge.net/): Cross platform OpenGL wrapper.
- [GLFW](http://www.glfw.org/): Cross platform OpenGL Application creation.
- [STB](http://www.glfw.org/): Single file utility libraries by Sean Barrett.
- [OpenAL-Soft](https://github.com/kcat/openal-soft): Software implementation of the OpenAL 3D audio API.