README: Improved build and usage instructions. #75
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Calinou
reviewed
Mar 10, 2025
Calinou
reviewed
Mar 10, 2025
Calinou
reviewed
Mar 10, 2025
README.md
Outdated
| 4. [Build godot for iOS target](https://docs.godotengine.org/en/stable/contributing/development/compiling/compiling_for_ios.html). `scons platform=ios target=editor` | ||
|
|
||
|
|
||
| 5. Run plugin creation script. This step need to be repeated for each of the plugins you want to use. Go to the root of this repository then run `./scripts/generate_xcframework.sh <plugin_name> <debug|release|release_debug> 4.0`. The result will be an xcframework in bin directory. |
There was a problem hiding this comment.
Suggested change
| 5. Run plugin creation script. This step need to be repeated for each of the plugins you want to use. Go to the root of this repository then run `./scripts/generate_xcframework.sh <plugin_name> <debug|release|release_debug> 4.0`. The result will be an xcframework in bin directory. | |
| 5. Run the plugin creation script. This step needs to be repeated for each of the plugins you want to use. Go to the root of this repository then run `./scripts/generate_xcframework.sh <plugin_name> <debug|release|release_debug> 4.4`. The result will be an xcframework in bin directory. |
There was a problem hiding this comment.
See scons configuration file, the two options are 3.x and 4.0.
Calinou
reviewed
Mar 10, 2025
README.md
Outdated
|
|
||
| You don't have to wait for full engine compilation, as header files are generated first. | ||
| Once the actual compilation starts, you can stop this command by pressing <kbd>Ctrl + C</kbd>. | ||
| 1. After cloning this repository, go to `godot` submodule and checkout the tag of the engine version you are working with. For example `4.3-stable`. |
There was a problem hiding this comment.
git switch is preferred over git checkout nowadays, as it avoids the ambiguity of git checkout also being able to work as git restore:
Suggested change
| 1. After cloning this repository, go to `godot` submodule and checkout the tag of the engine version you are working with. For example `4.3-stable`. | |
| 1. After cloning this repository, go to `godot` submodule and switch to the tag of the engine version you are working with. For example, `git switch 4.4-stable`. |
There was a problem hiding this comment.
It's a tag so should be "git checkout" and not "switch".
Calinou
reviewed
Mar 10, 2025
Calinou
reviewed
Mar 10, 2025
Calinou
reviewed
Mar 10, 2025
Calinou
reviewed
Mar 10, 2025
Calinou
suggested changes
Mar 10, 2025
Co-authored-by: Hugo Locurcio <[email protected]>
|
I applied the suggestions except two changes I commented about. |
Calinou
reviewed
Mar 10, 2025
Calinou
reviewed
Mar 10, 2025
Co-authored-by: Hugo Locurcio <[email protected]>
Calinou
approved these changes
Mar 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
After tinkering with it, took me some time to make it working. Hope these clarifications in the docs will save others some time.