Skip to content

Commit

Permalink
Update ReadMe, Contribute, Funding
Browse files Browse the repository at this point in the history
  • Loading branch information
Bromeon committed Oct 26, 2023
1 parent e6debc9 commit 43f5d2f
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 9 deletions.
15 changes: 15 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# These are supported funding model platforms

# Up to 4 GitHub Sponsors usernames
github: [Bromeon, lilizoey]

#patreon: # Replace with a single Patreon username
#open_collective: # Replace with a single Open Collective username
#ko_fi: # Replace with a single Ko-fi username
#tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
#community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
#liberapay: # Replace with a single Liberapay username
#issuehunt: # Replace with a single IssueHunt username
#otechie: # Replace with a single Otechie username
#lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
#custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
4 changes: 2 additions & 2 deletions Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Larger code style changes should be split though.

If your pull request changes a single thing, please squash the commits into one. Avoid commits like "integrate review feedback" or "fix rustfmt".
Instead, use `git commit --amend` or `git rebase -i` and force-push follow-up commits to your branch (`git push --force-with-lease`).
Since we use the _bors_ bot to merge PRs, we can unfortunately not squash commits upon merge.
Since we use GitHub merge queues, we can unfortunately not decide to squash commits upon merge per PR.


### Draft PRs
Expand All @@ -41,4 +41,4 @@ The book also elaborates design principles and conventions behind our API.

[GitHub issue]: https://github.com/godot-rust/gdext/issues
[Discord]: https://discord.gg/aKUCJ8rJsc
[godot-rust book](https://godot-rust.github.io/gdext/contribute).
[godot-rust book]: https://godot-rust.github.io/book/contribute
15 changes: 8 additions & 7 deletions ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

# Rust bindings for Godot 4

_**[Website]** | **[API Docs]** | [Discord] | [Mastodon] | [Twitter]_
_**[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 bind the Rust language to Godot 4.

[Godot] is an open-source game engine, whose version 4 has brought large-scale improvements.
Its _GDExtension_ API allows integrating third-party languages and libraries.

> If you are looking for a Rust binding for GDNative (Godot 3), check out [`gdnative`].
> If you are looking for a Rust binding for Godot 3 (GDNative API), check out [`gdnative`].

## Philosophy
Expand All @@ -31,11 +31,11 @@ However, it is still in an early stage and there are certain things to keep in m
> The public API introduces breaking changes from time to time. Most of these are motivated by new features and
> 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.
**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, iOS or WASM. 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 due to feedback and testing over time.
new additions to the library are typically not feature-complete from the start, but become more robust with feedback and testing over time.
To counter bugs, we have an elaborate CI suite including clippy, unit tests, engine integration tests and memory sanitizers.


Expand Down Expand Up @@ -67,12 +67,13 @@ Contributions are very welcome! If you want to help out, see [`Contributing.md`]
[#24]: https://github.com/godot-rust/gdext/issues/24
[`gdnative`]: https://github.com/godot-rust/gdnative
[API Docs]: https://godot-rust.github.io/docs/gdext
[API stability]: https://godot-rust.github.io/book/gdext/advanced/compatibility.html#rust-api-stability
[book]: https://godot-rust.github.io/book/gdext
[API stability]: https://godot-rust.github.io/book/toolchain/compatibility.html#rust-api-stability
[book]: https://godot-rust.github.io/book
[Discord]: https://discord.gg/aKUCJ8rJsc
[dodge-the-creeps]: examples/dodge-the-creeps
[Godot]: https://godotengine.org
[Mastodon]: https://mastodon.gamedev.place/@GodotRust
[mpl]: https://www.mozilla.org/en-US/MPL
[Sponsor]: https://github.com/sponsors/Bromeon
[Twitter]: https://twitter.com/GodotRust
[Website]: https://godot-rust.github.io

0 comments on commit 43f5d2f

Please sign in to comment.