aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexander M Pickering <alex@cogarr.net>2023-04-27 19:05:14 -0500
committerAlexander M Pickering <alex@cogarr.net>2023-04-27 19:05:14 -0500
commit5756a3ae8b047b368200e4ba5f62d9ac96aad349 (patch)
tree4e4e7d94cf5cff54cdc9a37877c08208ef20e5c8
parent2c9065dfbd9a6c655bbc5bf9b6dc332bcb10a7bf (diff)
downloadbrokengine-5756a3ae8b047b368200e4ba5f62d9ac96aad349.tar.gz
brokengine-5756a3ae8b047b368200e4ba5f62d9ac96aad349.tar.bz2
brokengine-5756a3ae8b047b368200e4ba5f62d9ac96aad349.zip
Update readme with new cicd links
-rw-r--r--README.md7
1 files changed, 3 insertions, 4 deletions
diff --git a/README.md b/README.md
index cee8790..2a29d33 100644
--- a/README.md
+++ b/README.md
@@ -6,9 +6,8 @@ Broken Engine is a hobby game engine that glues [Bullet Physics](bulletphysics.o
## 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.
-
-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!
+Binaries for Windows are available from the [here](https://cicd.cogarr.net/archive/brokengine-win/latest/brokengine_client.zip)
+Binaries for Linux can be built:
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`
@@ -17,7 +16,7 @@ Alternatively, you could download either of the [two](https://cogarr.net/source/
4. Initally ran scripts can be found at bin/(client|server)/data/init.lua
## Documentation
-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.
+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://docs.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.