Bromeon / book

The user guide for godot-rust.

The godot-rust book

The godot-rust book is a user guide for the Rust bindings. The book is still work-in-progress, and contributions are very welcome.

An online version of the book is available at godot-rust.github.io/book.

The book is built with mdBook and the plugin mdbook-toc. To install them and build the book locally, you can run:

$ cargo install mdbook mdbook-toc
$ mdbook build

To run a local server with automatic updates while editing the book, use:

$ mdbook serve --open

Contributing

This repository is for documentation only. Please open pull requests targeting the libraries themselves in the main repos for the Godot 3 and Godot 4 bindings.

For contributions, see the contributing guidelines under CONTRIBUTING.md in the above-mentioned repositories.

License

Any contribution intentionally submitted for inclusion in the work by you shall be licensed under the MIT license, without any additional terms or conditions.