Update hello world example to use repo on crates.io #51
Conversation
src/intro/hello-world.md
Outdated
| ```log | ||
| $ cargo build | ||
| Compiling godot4-prebuilt v0.0.0 | ||
| (https://github.com/godot-rust/godot4-prebuilt?branch=4.1.1#fca6897d) | ||
| Compiling proc-macro2 v1.0.69 | ||
| [...] | ||
| Compiling godot v0.1.0 (https://github.com/godot-rust/gdext?branch=master#66df8f47) | ||
| Compiling godot-cell v0.1.1 | ||
| Compiling glam v0.27.0 | ||
| Compiling godot-core v0.1.1 | ||
| Compiling godot-ffi v0.1.1 | ||
| Compiling godot v0.1.1 |
There was a problem hiding this comment.
I think this is a good example why we shouldn't include the log. It will already be outdated on next crates.io release again, and anytime we change dependencies, it becomes inaccurate. Furthermore, the output differs depending on the number of crates that have changed (it's not a full rebuild).
Could you remove the whole cargo build log?
The part about ls -l is also a bit strange, because ls doesn't typically show nested directories, nor does it put them in a frame. Maybe we should use a more conventional output here, following a ls -l target/debug command. But we can also just keep it OS-independent with a paragraph like
After building, you should have the following files in the
target/debugdirectory. Note that this applies to Linux, on Windows and macOS you will have different dynamic library names and file extensions.
src/intro/hello-world.md
Outdated
| [dependencies] | ||
| godot = { git = "https://github.com/godot-rust/gdext", branch = "master" } | ||
| godot = "0.1" | ||
| ``` |
There was a problem hiding this comment.
I think we should keep both versions, for users who want a crates release and users who want to follow bleeding-edge development. Maybe mention the crates.io one first, and then introduce the GitHub one.
|
@kyle-watson Any update? 🙂 |
|
Can we maybe recommend using |
| @@ -91,7 +93,7 @@ This should output to `{YourCrate}/target/debug/` at least one variation of a co | |||
|
|
|||
| ```admonish tip | |||
| For users who want to follow bleeding-edge development, you can directly link the github repo in your `Cargo.toml` dependencies section by replacing: | |||
| `godot = "0.1"` | |||
| `godot = "X.X.X"` | |||
There was a problem hiding this comment.
| `godot = "X.X.X"` | |
| `godot = "0.x.y"` |
So it's clear that the parts are different.
I think it's fair to update this if we get to version 1 😉
|
@kyle-watson Do you have an update on this? |
This is my first ever pull request, so please let me know if I messed anything up or if this isn't even a desired change. Also I am not positive if the Linux log is accurate as I compiled on windows and I replaced the parts of the log that looked similar.