From f85ab5c86db7d96b574e55555ebaa2eda7494790 Mon Sep 17 00:00:00 2001 From: Doyle Date: Fri, 5 Aug 2016 01:55:52 +1000 Subject: [PATCH] Add readme.md to project --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..08eed33 --- /dev/null +++ b/README.md @@ -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.