Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Command line tutorial for Godot 4.1 #7637

Merged

Conversation

Calinou
Copy link
Member

@Calinou Calinou commented Jul 10, 2023

  • Update list of command line arguments and descriptions to match Godot 4.1.
  • Add a legend to clearly denote which CLI arguments are supported in each build type.
    • This is something we could add to --help's output as part of Add colors to the command-line help godot#36252, so that you know which arguments are not present in less full-featured build types. (We wouldn't display non-functional arguments in export template builds though.)
  • Add instructions on making Godot easily available in the PATH on Windows and macOS.
  • Fix invalid backtick usage in some pages.

Preview

Screenshot_20230710_191455

Screenshot_20230710_191505

@Calinou Calinou added enhancement area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels Jul 10, 2023
- Update list of command line arguments and descriptions to match
  Godot 4.1.
- Add a legend to clearly denote which CLI arguments are supported
  in each build type.
- Add instructions on making Godot easily available in the `PATH`
  on Windows and macOS.
- Fix invalid backtick usage in some pages.
@mhilbrunner
Copy link
Member

I wonder if there is a way to auto-generate the list of arguments and descriptions by calling the Godot executable and getting it's help output. Would help them stay in sync.

Probably does not change often enough to do that work though, and may make translations more difficult, not sure.

Anyway, thats kinda unrelated to this PR besides it fixing that outdated content, so thanks! Merged.

@mhilbrunner mhilbrunner merged commit 75edc77 into godotengine:master Jul 18, 2023
1 check passed
@Calinou Calinou deleted the update-command-line-tutorial branch July 27, 2023 06:17
nhunt290 pushed a commit to nhunt290/godot-docs that referenced this pull request Sep 25, 2023
GeneralProtectionFault pushed a commit to GeneralProtectionFault/godot-docs that referenced this pull request Oct 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants