Skip to content

Commit 0489074

Browse files
committed
Update ReadMe/Contributing, rename page /doc -> /docs
1 parent 5165843 commit 0489074

File tree

3 files changed

+33
-27
lines changed

3 files changed

+33
-27
lines changed

.github/workflows/doc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ env:
1919
//! _For stable releases, visit [docs.rs/gdnative](https://docs.rs/gdnative)._
2020
//! <br><br>
2121
//!
22-
GDNATIVE_DOC_REPO: git@github.com:godot-rust/doc.git
22+
GDNATIVE_DOC_REPO: git@github.com:godot-rust/docs.git
2323
GDNATIVE_DOC_BRANCH: gh-pages
2424

2525

CONTRIBUTING.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# Contributing to godot's rust bindings.
22

3-
The godot rust bindings developers welcome contribution from everyone. Here are the guidelines if you are thinking of helping us:
3+
The godot-rust bindings developers welcome contribution from everyone. Here are the guidelines if you are thinking of helping us:
44

55
## Contributions
66

7-
Contributions to should be made in the form of GitHub pull requests.
8-
Each pull request will be reviewed by a core contributor (someone with permission to land patches) and either landed in the main tree or given feedback for changes that would be required.
7+
Contributions should be made in the form of GitHub pull requests (PRs). Each pull request will be reviewed by a core contributor (someone with permission to land patches) and either landed in the main tree or given feedback for changes that would be required.
8+
9+
When opening a PR, our continuous integration (CI) pipeline will automatically perform a few basic checks (formatting, lints, unit tests). Please make sure those checks pass, adjusting your code if necessary.
910

1011
Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on it. This is to prevent duplicated efforts from contributors on the same issue.
1112

@@ -17,7 +18,7 @@ Have a look at the [issues](https://github.com/godot-rust/godot-rust/issues) to
1718

1819
- Branch from the master branch and, if needed, rebase to the current master branch before submitting your pull request. If it doesn't merge cleanly with master you may be asked to rebase your changes.
1920

20-
- Commits should be as small as possible, while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests).
21+
- Use one commit per logical change. Often, PRs only consist of a single commit. If you change unrelated parts of the code, split it into separate commits.
2122

2223
- If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment.
2324

@@ -27,8 +28,9 @@ Have a look at the [issues](https://github.com/godot-rust/godot-rust/issues) to
2728

2829
## Testing
2930

30-
- run `cargo test --all` from the root of the repository.
31-
- on GNU/Linux OSes:
31+
Everywhere: run `cargo test --workspace` from the root of the repository.
32+
33+
On GNU/Linux operating systems:
3234

3335
```
3436
cd test
@@ -61,8 +63,8 @@ Primary communication between developers of the project happens on the `godot-ru
6163
For questions about using `godot-rust` the `#gdnative` channel on the [Godot Engine community Discord server](https://godotengine.org/community) can be used.
6264
On IRC the `#godotengine-gdnative` channel on freenode can be used for questions as well.
6365

64-
If those platforms are not accessible enough for you let us know and we can look into opening new channels and possibly bridging them if needed.
66+
If you are only interested in occasional announcements and showcases, follow [@GodotRust on Twitter](https://twitter.com/GodotRust). For questions and design discussions, please use Discord.
6567

6668
## License
6769

68-
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be licensed under the [MIT license](LICENSE.md), without any additional terms or conditions.
70+
Any contribution submitted for inclusion in the work by you shall be licensed under the [MIT license](LICENSE.md), without any additional terms or conditions.

README.md

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,23 @@
44

55
[![Docs Status](https://docs.rs/gdnative/badge.svg)](https://docs.rs/gdnative)
66

7-
Rust bindings to the [Godot game engine](http://godotengine.org/).
87

9-
**[Website](https://godot-rust.github.io/)** |
10-
**[User Guide](https://godot-rust.github.io/book/)** | **[API Documentation](https://docs.rs/gdnative/0.9.3/gdnative/)**
8+
**[Website](https://godot-rust.github.io)** |
9+
**[User Guide](https://godot-rust.github.io/book)** | **[Stable Docs](https://docs.rs/gdnative)** | **[Latest Docs](https://godot-rust.github.io/docs)**
10+
11+
**godot-rust** is a Rust library that implements native bindings for the [Godot game engine](http://godotengine.org/). This allows you to develop games or other applications in Godot, while benefiting from Rust's strengths, such as its type system, scalability and performance.
1112

1213
## Stability
1314

14-
The bindings cover most of the exposed API of Godot 3.2, and are being used on a number of projects in development, but we still expect non-trivial breaking changes in the API in the coming releases.
15+
The bindings cover most of the exposed API of Godot 3.2, and are being used on a number of projects in development, but we still expect non-trivial breaking changes in the API in the coming releases. godot-rust adheres to [Cargo's semantic versioning](https://doc.rust-lang.org/cargo/reference/semver.html).
1516

1617
## Engine compatibility
1718

18-
We are serious about engine compatibility. We are committed to keeping compatibility with the latest stable patch releases of all minor versions of the engine, starting from Godot 3.2.
19+
We are committed to keeping compatibility with the latest stable patch releases of all minor versions of the engine, starting from Godot 3.2.
1920

20-
The current minimum compatible version, with `api.json` replacement, is Godot 3.2-stable. Changes to this will be considered a breaking change, and will be called out in the release notes.
21+
The current minimum compatible version, with `api.json` replacement, is Godot 3.2. Godot 3.3 is supported as well. Changes to this will be considered a breaking change, and will be called out in the release notes.
2122

22-
The bindings do *not* support Godot 4.0 (`master` branch) currently.
23+
The bindings do _**not**_ support Godot 4.0 currently. Support is planned as the native extensions become more stable.
2324

2425
## Requirements
2526

@@ -80,7 +81,7 @@ impl HelloWorld {
8081

8182
#[export]
8283
fn _ready(&self, _owner: &Node) {
83-
godot_print!("hello, world.");
84+
godot_print!("Hello, world.");
8485
}
8586
}
8687

@@ -111,23 +112,26 @@ The [/examples](https://github.com/godot-rust/godot-rust/tree/master/examples) d
111112

112113
## Third-party resources
113114

114-
### Tutorials
115+
### Tools and integrations
115116

116-
- Step by step guide - [Up and running with Rust and Godot: A basic setup](https://hagsteel.com/posts/godot-rust/)
117+
- [godot-egui](https://github.com/setzer22/godot-egui) (setzer22, jacobsky) - combine the [egui](https://github.com/emilk/egui) library with Godot
118+
- [ftw](https://github.com/macalimlim/ftw) (macalimlim) - manage your godot-rust projects from the command line
119+
120+
### Open-source games
117121

118-
### Open-source projects
122+
- [Action RPG](https://github.com/MacKarp/Rust_Action_RPG_Tutorial) (MacKarp) - this [Godot tutorial](https://www.youtube.com/playlist?list=PL9FzW-m48fn2SlrW0KoLT4n5egNdX-W9a) ported to Rust.
123+
- [Air Combat](https://github.com/paytonrules/AirCombat) (paytonrules) - this [Godot tutorial](https://devga.me/tutorials/godot2d/) ported to Rust.
124+
- [Simple single-player Blackjack](https://github.com/paytonrules/Blackjack) (paytonrules)
125+
- [Pong](https://github.com/you-win/godot-pong-rust) (you-win)
119126

120-
- Pong - https://github.com/you-win/godot-pong-rust
121-
- Air Combat - https://github.com/paytonrules/AirCombat - This [Godot Tutorial](https://devga.me/tutorials/godot2d/) ported to Rust.
122-
- Action RPG - https://github.com/MacKarp/Rust_Action_RPG_Tutorial - This [Godot Tutorial](https://www.youtube.com/playlist?list=PL9FzW-m48fn2SlrW0KoLT4n5egNdX-W9a) ported to Rust.
123-
- Simple Single-Player Blackjack - https://github.com/paytonrules/Blackjack
127+
### Tutorials
128+
129+
- Step by step guide - [Up and running with Rust and Godot: A basic setup](https://hagsteel.com/posts/godot-rust/)
124130

125-
### Tools
126-
- ftw - https://github.com/macalimlim/ftw - manage your godot-rust projects!
127131

128132
## Contributing
129133

130-
See the [contribution guidelines](CONTRIBUTING.md)
134+
See the [contribution guidelines](CONTRIBUTING.md).
131135

132136
## License
133137

0 commit comments

Comments
 (0)