Merge pull request #804 from godot-rust/qol/crates-readme

Add crates.io ReadMe + docs logo

Author: Bromeon

ReadMe.md

@@ -1,12 +1,12 @@
-![logo.png](assets/gdext-ferris.png)
+![logo.png](misc/assets/gdext-ferris.png)
 
 # Rust bindings for Godot 4
 
 _**[Website]** | **[Book][book]** | **[API Docs]** | [Discord] | [Mastodon] | [Twitter] | [Sponsor]_
 
-**gdext** is a library to bind the Rust language to Godot 4.
+**gdext** is a library to integrate the Rust language with Godot 4.
 
-[Godot] is an open-source game engine, whose version 4 has brought large-scale improvements.  
+[Godot] is an open-source game engine, focusing on a productive and batteries-included 2D and 3D experience.  
 Its _GDExtension_ API allows integrating third-party languages and libraries.
 
 If you are looking for a Rust binding for Godot 3 (GDNative API), check out [`gdnative`].
@@ -32,7 +32,7 @@ However, there are still certain things to keep in mind.
 > improved ergonomics for existing ones. See also [API stability] in the book.
 
 **Features:** While most Godot features are available, some less commonly used ones are missing. See [#24] for an up-to-date overview.
-At this point, there is **no** support for [Android] or [iOS], and [WASM] is experimental. Contributions are very welcome!
+At this point, there is little support for [Android] or [iOS], and [Wasm] is experimental. Contributions are very welcome!
 
 **Bugs:** Most undefined behavior related to the FFI layer has been ironed out, but there may still be occasional safety issues. Apart from that,
 new additions to the library are typically not feature-complete from the start, but become more robust with feedback and testing over time.

godot/Cargo.toml

@@ -11,6 +11,7 @@ authors = ["Bromeon", "godot-rust contributors"]
 repository = "https://github.com/godot-rust/gdext"
 homepage = "https://godot-rust.github.io"
 documentation = "https://docs.rs/godot/0.1.2"
+readme = "crate-readme.md"
 
 [features]
 custom-godot = ["api-custom"]

godot/crate-readme.md

@@ -0,0 +1,85 @@
+![logo.png](https://github.com/godot-rust/assets/blob/master/gdext/banner.png?raw=true)
+
+# Rust bindings for Godot 4
+
+_**[Website]** | **[GitHub]** | **[Book]** | **[API Docs]** | [Discord] | [Mastodon] | [Twitter] | [Sponsor]_
+
+The **godot** crate integrates the Rust language with Godot 4.
+
+[Godot] is an open-source game engine, focusing on a productive and batteries-included 2D and 3D experience.  
+Its _GDExtension_ API allows integrating third-party languages and libraries.
+
+
+## Philosophy
+
+The Rust binding is an alternative to GDScript, with a focus on type safety, scalability and performance.
+
+The primary goal of this library is to provide a [**pragmatic Rust API**][philosophy] for game developers.
+Recurring workflows should be simple and require minimal boilerplate. APIs are designed to be safe and idiomatic Rust wherever possible.
+Due to interacting with Godot as a C++ engine, we sometimes follow unconventional approaches to provide a good user experience.
+
+
+## Example
+
+The following code snippet demonstrates writing a simple Godot class `Player` in Rust.
+
+```rust
+use godot::prelude::*;
+use godot::classes::{ISprite2D, Sprite2D};
+
+// Declare the Player class inheriting Sprite2D.
+#[derive(GodotClass)]
+#[class(base=Sprite2D)]
+struct Player {
+    // Inheritance via composition: access to Sprite2D methods.
+    base: Base<Sprite2D>,
+
+    // Other fields.
+    velocity: Vector2,
+    hitpoints: i32,
+}
+
+// Implement Godot's virtual methods via predefined trait.
+#[godot_api]
+impl ISprite2D for Player {
+    // Default constructor (base object is passed in).
+    fn init(base: Base<Sprite2D>) -> Self {
+        Player {
+            base,
+            velocity: Vector2::ZERO,
+            hitpoints: 100,
+        }
+    }
+
+    // Override the `_ready` method.
+    fn ready(&mut self) {
+        godot_print!("Player ready!");
+    }
+}
+
+// Implement custom methods that can be called from GDScript.
+#[godot_api]
+impl Player {
+    #[func]
+    fn take_damage(&mut self, damage: i32) {
+        self.hitpoints -= damage;
+        godot_print!("Player hit! HP left: {}", self.hitpoints);
+    }
+}
+```
+
+## More
+
+For more information, check out our [Website] or [GitHub] page!
+
+
+[API Docs]: https://godot-rust.github.io/docs/gdext
+[Book]: https://godot-rust.github.io/book
+[Discord]: https://discord.gg/aKUCJ8rJsc
+[GitHub]: https://github.com/godot-rust/gdext
+[Godot]: https://godotengine.org
+[Mastodon]: https://mastodon.gamedev.place/@GodotRust
+[philosophy]: https://godot-rust.github.io/book/contribute/philosophy.html
+[Sponsor]: https://github.com/sponsors/Bromeon
+[Twitter]: https://twitter.com/GodotRust
+[Website]: https://godot-rust.github.io

godot/src/lib.rs

@@ -115,6 +115,10 @@
 //!   The serialized representation underlies **no stability guarantees** and may change at any time, even without a SemVer-breaking change.
 //!
 
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/godot-rust/assets/master/gdext/ferris.svg"
+)]
+
 #[cfg(doc)]
 pub mod __docs;