diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 4 |
1 files changed, 2 insertions, 2 deletions
@@ -10,14 +10,14 @@ Binaries will not be provided until Brok[en]gine reaches version 1.0, if you wan Alternatively, you could download either of the [two](https://cogarr.net/source/cgit.cgi/home_text_adventure/) [games](http://cogarr.net/source/cgit.cgi/mahjong_solitaire/about/) to see Brok[en]gine in action! -1. Use [git](git-scm.com) to download this with submodules `git clone --recurse-submodules https://cogarr.net/source/cgi.cgit/brokengine` +1. Use [git](git-scm.com) to download this repository with submodules `git clone --recurse-submodules https://cogarr.net/source/cgit.cgi/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 DEBUG=true` 1. For some god-awful reason, when useing MSYS2 under windows, you need to define MSYSTEM=MINGW64 as an environment variable to get luajit to compile. `set MSYSTEM=MINGW64` 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 -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. +Documentation is built using [mdoc](https://cogarr.net/source/cgit.cgi/mdoc/about/), and you can build it with `make doc`; documentation is located under the `/doc/` folder. Open index.html to view. Alternatively, you can browse an online copy of the documentation [here](https://cogarr.net/brokengine/), which is always up to date with the newest Brok[en]gine code. ## Misc. This project is under very heavy development. Expect lots of code churn for the foreseeable future. |