diff options
| author | Alexander Pickering <alex@cogarr.net> | 2018-10-31 12:47:37 -0400 |
|---|---|---|
| committer | Alexander Pickering <alex@cogarr.net> | 2018-10-31 12:49:47 -0400 |
| commit | 8291075aeaf614c2f8dc0a0f4c199fd4a0d45cdd (patch) | |
| tree | abc3c3a34eb832aea868bd5114d888a9e3c15dfa /doc/topics/readme.md.html | |
| parent | 9e9be703c8f1c58c76fd2051dd6fa6ce49a7a306 (diff) | |
| download | brokengine-8291075aeaf614c2f8dc0a0f4c199fd4a0d45cdd.tar.gz brokengine-8291075aeaf614c2f8dc0a0f4c199fd4a0d45cdd.tar.bz2 brokengine-8291075aeaf614c2f8dc0a0f4c199fd4a0d45cdd.zip | |
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.
Diffstat (limited to 'doc/topics/readme.md.html')
| -rw-r--r-- | doc/topics/readme.md.html | 81 |
1 files changed, 0 insertions, 81 deletions
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 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -<html> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> -<head> - <title>Reference</title> - <link rel="stylesheet" href="../ldoc.css" type="text/css" /> -</head> -<body> - -<div id="container"> - -<div id="product"> - <div id="product_logo"></div> - <div id="product_name"><big><b></b></big></div> - <div id="product_description"></div> -</div> <!-- id="product" --> - - -<div id="main"> - - -<!-- Menu --> - -<div id="navigation"> -<br/> -<h1>Brok[en]gine</h1> - - -<h2>Contents</h2> -<ul> -<li><a href="#Download">Download </a></li> -<li><a href="#Documentation">Documentation </a></li> -<li><a href="#Misc">Misc </a></li> -</ul> - - -<h2>Topics</h2> -<ul class=""> - <li><strong>readme</strong></li> -</ul> -<h2>Modules</h2> -<ul class="nowrap"> - <li><a href="../index.html">net</a></li> -</ul> - -</div> - -<div id="content"> - - # Brok[en]gine -<p> -<p>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. -<p>## Download -<p>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. -<p>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 -<p>## Documentation -Currently, documentation does not exist... I'll get around to it before 1.0 -<p>## Misc. -This project is under very heavy development. Expect lots of code churn for the foreseeable future. -<p>### 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 - - -</div> <!-- id="content" --> -</div> <!-- id="main" --> -<div id="about"> -<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> -<i style="float:right;">Last updated 2018-07-03 16:38:22 </i> -</div> <!-- id="about" --> -</div> <!-- id="container" --> -</body> -</html> |