Skip to content

Latest commit

 

History

History
30 lines (17 loc) · 1.03 KB

README.md

File metadata and controls

30 lines (17 loc) · 1.03 KB

The godot-rust book

The godot-rust book is a user guide for the Rust bindings. The book is currently an early 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. To 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, run:

$ mdbook serve

This repository is for documentation only. Please make pull requests for the library itself in the main repo.

Contributing

See the contribution guidelines in the main repo.

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.