Skip to content

Commit

Permalink
Update ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
Bromeon committed Oct 10, 2023
1 parent 2639118 commit 8ed3f5c
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# The godot-rust book
# gdnative 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.
The gdnative book is a user guide for the [gdnative library][gdnative], the Rust bindings to Godot 3.

An online version of the book is available at [godot-rust.github.io/gdnative-book][book-web].
For the gdext book, check out [gdext-book].
For the gdext book (Godot 4), check out [gdext-book].

The book is built with [mdBook] and the plugins [mdbook-toc] and [mdbook-admonish]. To install them and build the book locally, you can run:
```bash
Expand All @@ -28,7 +28,8 @@ For contributions, see the contributing guidelines under `CONTRIBUTING.md` in th

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

[book-web]: https://godot-rust.github.io/book
[gdnative]: https://github.com/godot-rust/gdnative
[book-web]: https://godot-rust.github.io/gdnative-book
[gdext-book]: https://github.com/godot-rust/book
[mdBook]: https://github.com/rust-lang-nursery/mdBook
[mdbook-toc]: https://github.com/badboy/mdbook-toc
Expand Down

0 comments on commit 8ed3f5c

Please sign in to comment.