Skip to content

Commit 43f5d2f

Browse files
committed
Update ReadMe, Contribute, Funding
1 parent e6debc9 commit 43f5d2f

File tree

3 files changed

+25
-9
lines changed

3 files changed

+25
-9
lines changed

.github/FUNDING.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# These are supported funding model platforms
2+
3+
# Up to 4 GitHub Sponsors usernames
4+
github: [Bromeon, lilizoey]
5+
6+
#patreon: # Replace with a single Patreon username
7+
#open_collective: # Replace with a single Open Collective username
8+
#ko_fi: # Replace with a single Ko-fi username
9+
#tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
10+
#community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
11+
#liberapay: # Replace with a single Liberapay username
12+
#issuehunt: # Replace with a single IssueHunt username
13+
#otechie: # Replace with a single Otechie username
14+
#lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
15+
#custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

Contributing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Larger code style changes should be split though.
2323

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

2828

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

4242
[GitHub issue]: https://github.com/godot-rust/gdext/issues
4343
[Discord]: https://discord.gg/aKUCJ8rJsc
44-
[godot-rust book](https://godot-rust.github.io/gdext/contribute).
44+
[godot-rust book]: https://godot-rust.github.io/book/contribute

ReadMe.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
# Rust bindings for Godot 4
44

5-
_**[Website]** | **[API Docs]** | [Discord] | [Mastodon] | [Twitter]_
5+
_**[Website]** | **[Book][book]** | **[API Docs]** | [Discord] | [Mastodon] | [Twitter] | [Sponsor]_
66

7-
**gdext** is a library to bind the **Rust** language to **Godot 4**.
7+
**gdext** is a library to bind the Rust language to Godot 4.
88

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

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

1515
## Philosophy
@@ -31,11 +31,11 @@ However, it is still in an early stage and there are certain things to keep in m
3131
> The public API introduces breaking changes from time to time. Most of these are motivated by new features and
3232
> improved ergonomics for existing ones. 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.
34+
**Features:** While most Godot features are available, some less commonly used ones are missing. See [#24] for an up-to-date overview.
3535
At this point, there is **no** support for Android, iOS or WASM. Contributions are very welcome!
3636

3737
**Bugs:** Most undefined behavior related to the FFI layer has been ironed out, but there may still be occasional safety issues. Apart from that,
38-
new additions to the library are typically not feature-complete from the start, but become more robust due to feedback and testing over time.
38+
new additions to the library are typically not feature-complete from the start, but become more robust with feedback and testing over time.
3939
To counter bugs, we have an elaborate CI suite including clippy, unit tests, engine integration tests and memory sanitizers.
4040

4141

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

0 commit comments

Comments
 (0)