aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlexander Pickering <alex@cogarr.net>2018-08-12 15:15:55 -0400
committerAlexander Pickering <alex@cogarr.net>2018-08-12 15:15:55 -0400
commita4851728b6db3dd37006d08fc05684dc28e03aa3 (patch)
treeeb7fecd03c10406b2350f0c161409b8e147d7576 /README.md
parent1d41307e2b2c8fc7051a652f115f7078470905fc (diff)
downloadbrokengine-a4851728b6db3dd37006d08fc05684dc28e03aa3.tar.gz
brokengine-a4851728b6db3dd37006d08fc05684dc28e03aa3.tar.bz2
brokengine-a4851728b6db3dd37006d08fc05684dc28e03aa3.zip
Updated readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 9 insertions, 8 deletions
diff --git a/README.md b/README.md
index a211ea4..734f51c 100644
--- a/README.md
+++ b/README.md
@@ -9,20 +9,21 @@ Broken Engine is a hobby game engine that glues [Bullet Physics](bulletphysics.o
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`
+2. Download make, g++, ect. Windows users can use [mingw](https://mingw.org). Open a terminal and cd into this folder, and run `make DEBUG=true`
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
+Documentation is built using [ldoc](https://github.com/stevedonovan/LDoc), just use cd into this folder and use `ldoc .`; documentation is located under the `/doc/` folder. Open index.html to view.
## 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
+0. ~~Lua-defined textures~~
+0. ~~Lua-defined materials~~
+0. Bind all the irrlicht gui things to lua
+0. Lua-defined models
+0. Lua-defined hitboxes
+0. Networking utilities
+0. Make a tech demo game