Skip to content

Commit 62bceda

Browse files
authored
Merge pull request #929 from godot-rust/qol/readme
ReadMe update + clippy error
2 parents a0d5799 + 5b88788 commit 62bceda

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

ReadMe.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ _**[Website]** | **[Book][book]** | **[API Docs]** | [Discord] | [Mastodon] | [T
99
[Godot] is an open-source game engine, focusing on a productive and batteries-included 2D and 3D experience.
1010
Its _GDExtension_ API allows integrating third-party languages and libraries.
1111

12-
If you are looking for a Rust binding for Godot 3 (GDNative API), check out [`gdnative`].
12+
Rust bindings for Godot 3 (GDNative API) are available in [`gdnative`].
1313

1414

1515
## Philosophy
@@ -28,11 +28,13 @@ The gdext library has evolved a lot during 2023 and 2024 and is now in a usable
2828
However, there are still certain things to keep in mind.
2929

3030
> [!WARNING]
31-
> The public API introduces breaking changes from time to time. Most of these are motivated by new features and
32-
> improved ergonomics for existing ones. See also [API stability] in the book.
31+
> The public API introduces breaking changes from time to time, primarily motivated by new features and improved ergonomics.
32+
> Our [crates.io releases][crates-io] adhere to SemVer, but may lag behind the `master` branch. See also [API stability] in the book.
3333
34-
**Features:** While most Godot features are available, some less commonly used ones are missing. See [#24] for an up-to-date overview.
35-
At this point, there is little support for [Android] or [iOS], and [Wasm] is experimental. Contributions are very welcome!
34+
**Features:** Most Godot APIs have been mapped at this point. The current focus lies on a more natural Rust experience and enable more design
35+
patterns that come in handy for day-to-day game development. See [#24] for an up-to-date feature overview.
36+
37+
At the moment, there is experimental support for [Wasm], [Android] and [iOS], but documentation and tooling is still lacking. Contributions are very welcome!
3638

3739
**Bugs:** Most undefined behavior related to the FFI layer has been ironed out, but there may still be occasional safety issues. Apart from that,
3840
new additions to the library are typically not feature-complete from the start, but become more robust with feedback and testing over time.
@@ -42,14 +44,14 @@ To counter bugs, we have an elaborate CI suite including clippy, unit tests, eng
4244
## Getting started
4345

4446
To dive into Rust development with gdext, check out [the godot-rust book][book]. The book is still under construction,
45-
but already covers a Hello World setup as well as several more in-depth chapters.
47+
but already covers a _Hello World_ setup as well as several more in-depth chapters.
4648

4749
To consult the API reference, have a look at the online [API Docs].
4850

4951
Furthermore, we provide a small example game in the [`examples/dodge-the-creeps` directory][dodge-the-creeps].
5052
The example [`examples/hot-reload`][hot-reload] demonstrates hot-reloading in the Godot editor.
5153

52-
If you need help, join our [Discord] server and ask in the `#help-gdext` channel!
54+
If you need help, join our [Discord] server and ask in the `#help` channel!
5355

5456

5557
## License
@@ -82,4 +84,5 @@ Contributions are very welcome! If you want to help out, see [`Contributing.md`]
8284
[hot-reload]: examples/hot-reload
8385
[iOS]: https://github.com/godot-rust/gdext/issues/498
8486
[mpl]: https://www.mozilla.org/en-US/MPL
85-
[philosophy]: https://godot-rust.github.io/book/contribute/philosophy.html
87+
[philosophy]: https://godot-rust.github.io/book/contribute/philosophy.html
88+
[crates-io]: https://crates.io/crates/godot

itest/rust/src/framework/runner.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ fn print_file_header(file: String, last_file: &mut Option<String>) {
346346
}
347347

348348
fn extract_file_subtitle(file: &str) -> &str {
349-
if let Some(sep_pos) = file.rfind(&['/', '\\']) {
349+
if let Some(sep_pos) = file.rfind(['/', '\\']) {
350350
&file[sep_pos + 1..]
351351
} else {
352352
file

0 commit comments

Comments
 (0)