dragonruby-book/README.md

16 lines
640 B
Markdown
Raw Normal View History

2022-11-23 17:16:21 +01:00
# Building Games with DragonRuby
2022-11-23 16:58:58 +01:00
An open source book that walks you through how to build games with [DragonRuby Game Toolkit](https://dragonruby.org/toolkit/game).
2022-11-24 01:48:21 +01:00
## Developing
The book is authored and published with [mdBook](https://rust-lang.github.io/mdBook/guide/installation.html). Follow the installation instructions to get the `mdbook` binary installed.
Run `mdbook serve` to boot up the web server that handles compiling everything.
When the code is pushed to the `main` branch on GitHub, an action runs that deploys it to the `gh-pages` branch.
2022-11-24 01:48:21 +01:00
## Publishing
The 3D cover file is generated with https://diybookcovers.com/