From 8291075aeaf614c2f8dc0a0f4c199fd4a0d45cdd Mon Sep 17 00:00:00 2001 From: Alexander Pickering Date: Wed, 31 Oct 2018 12:47:37 -0400 Subject: Removed generated documentation Removed documentation, users should generate it on-the-fly if needed. This is to keep the codebase in a consistent state. If the code is changed, the documentation must be chagned too, otherwise it is possible to see the codebase with old documentation. Additionally, updaing documentation with changes to the codebase would clutter diffs. --- doc/topics/readme.md.html | 81 ----------------------------------------------- 1 file changed, 81 deletions(-) delete mode 100644 doc/topics/readme.md.html (limited to 'doc/topics') diff --git a/doc/topics/readme.md.html b/doc/topics/readme.md.html deleted file mode 100644 index f250100..0000000 --- a/doc/topics/readme.md.html +++ /dev/null @@ -1,81 +0,0 @@ - - - - - Reference - - - - -
- -
- -
-
-
- - -
- - - - - - -
- - # Brok[en]gine -

![logo](https://cogarr.net/files/alex/brokenengine_small.png) -

Broken Engine is a hobby game engine that glues [Bullet Physics](bulletphysics.org/wordpress), [Irrlicht](irrlicht.sourceforge.net), [Lua](www.lua.org), and [various](nanomsg.org) [other](www.boost.org) technologies togeather to give a realtime, 3d, physics engine. -

## Download -

Binaries will not be provided until Brok[en]gine reaches version 1.0, if you want to try it out before then, you will have to build the engine yourself. -

1. Use [git](git-scm.com) to download this with submodules `git clone --recurse-submodules https://cogarr.net/source/cgi.cgit/brokengine` -2. Download make, g++, ect. Windows users can use [mingw](https://mingw.org). Open a terminal and cd into this folder, and run `make` -3. Binaries can be found in bin/(client|server)/bin/ -4. Initally ran scripts can be found at bin/(client|server)/data/init.lua -

## Documentation -Currently, documentation does not exist... I'll get around to it before 1.0 -

## Misc. -This project is under very heavy development. Expect lots of code churn for the foreseeable future. -

### Roadmap -0. Lua-defined textures -1. Lua-defined materials -2. Lua-defined models -3. Lua-defined hitboxes -4. Networking utilities -5. Make a tech demo game - - -

-
-
-generated by LDoc 1.4.6 -Last updated 2018-07-03 16:38:22 -
-
- - -- cgit v1.2.3-70-g09d2