https://github.com/openra/book
The OpenRA Book for players, modders / game makers, and developers alike!
https://github.com/openra/book
book cc-by guide how-to manual mdbook openra openra-book
Last synced: 4 months ago
JSON representation
The OpenRA Book for players, modders / game makers, and developers alike!
- Host: GitHub
- URL: https://github.com/openra/book
- Owner: OpenRA
- License: cc-by-4.0
- Created: 2019-03-09T16:56:16.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-02-16T22:28:36.000Z (over 4 years ago)
- Last Synced: 2025-02-27T00:20:56.404Z (over 1 year ago)
- Topics: book, cc-by, guide, how-to, manual, mdbook, openra, openra-book
- Homepage: https://www.openra.net/book/
- Size: 4.35 MB
- Stars: 21
- Watchers: 11
- Forks: 8
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# The OpenRA Book
You can find the built book at https://www.openra.net/book/
[](https://travis-ci.org/OpenRA/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](https://creativecommons.org/licenses/by/4.0/) 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.
[`cargo`]: https://doc.rust-lang.org/cargo/
[`mdbook` doesn't support translations]: https://github.com/rust-lang-nursery/mdBook/issues/5
[`mdbook`]: https://github.com/rust-lang-nursery/mdBook/
[chat with us on Discord]: https://discord.openra.net
[LICENSE]: ./LICENSE
[mdbook#installation]: https://github.com/rust-lang-nursery/mdBook#installation
[open an issue on GitHub]: https://github.com/OpenRA/book/issues/new
[open pull requests]: https://github.com/OpenRA/book/pulls