The OpenRA Book

You can find the built book at https://www.openra.net/book/

Contact Us

• chat with us on Discord
• open an issue on GitHub

License

The OpenRA Book is under the CC-BY 4.0 license.

You can find the full text in the LICENSE file.

A non-legal human-friendly summary can be found here on the Creative Commons website.

That summary is not a substitute for the LICENSE.

Requirements

• mdbook version 0.4.x

NOTE: macOS users will need to install mdbook via cargo since mdbook does not distribute macOS binaries. See mdbook#installation for more information.

Build the book

To build the book run the following from the repository's root:

$ mdbook build

The output will be in the build/html/ subdirectory.

Using mdbook watch will build the book automatically each time a Markdown file in the src directory is changed.

View the built book

Open it in your web browser of choice:

Firefox:

$ firefox build/html/index.html                       # Linux
$ open -a "Firefox" build/html/index.html             # OS X
$ Start-Process "firefox.exe" .\build\html\index.html # Windows (PowerShell)
$ start firefox.exe .\build\html\index.html           # Windows (Cmd)

Chrome:

$ google-chrome build/html/index.html                 # Linux
$ open -a "Google Chrome" build/html/index.html       # OS X
$ Start-Process "chrome.exe" .\build\html\index.html  # Windows (PowerShell)
$ start chrome.exe .\build\html\index.html            # Windows (Cmd)

Serving the book locally

When serving the book, pages will automatically be updated when the associated source files are written to.

Run the following from the repository's root:

$ mdbook serve

Then navigate to http://localhost:3000 in your web browser of choice.

You can run mdbook help serve for serve-specific options such as changing the port used.

Contributing

We'd love your help!

Review in-progress work

Our open pull requests are new chapters or edits that we're currently working on. We would love if you would read through those and make comments for any suggestions or corrections!

Translations

We can not translate the book because mdbook doesn't support translations yet.