Update compiling_with_dotnet.rst: clarify NuGet source creation #8805
Conversation
This file contains 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
raulsntos
added
enhancement
topic:dotnet
area:contributing
skyace65
approved these changes
Jan 23, 2024
|
Thanks! |
mhilbrunner
pushed a commit
that referenced
this pull request
Jan 25, 2024
Update compiling_with_dotnet.rst: clarify NuGet source creation
|
Cherry-picked to 4.2. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Someone building on Windows and unfamiliar with Linuxy paths, in particular
~, will try to rundotnet nuget add source ~/MyLocalNugetSource --name MyLocalNugetSourceverbatim, get an error having to do with~/MyLocalNugetSource, and not know where to go from there. (This has brought a few people to the C# Discord help channel.)I think this page deserves to be friendly even though it's focused on engine devs: people come here without being engine devs to e.g. compile the engine with double precision.
I added a little bit of info on how/where to set up the dir depending on OS, and used
<my_local_source>to refer to the dir. (Similar to using<godot_binary>earlier in the doc.)The paragraph starting with
The Godot NuGet packages must be added to that local source.seemed to me like it could be confused for something the doc is instructing the dev to do right then and there, and it seems redundant vs. the explanation that's already there a few paragraphs later, so I tried removing it. Maybe the doc isn't as good at convincing the dev to use the--push-nupkgs-localarg, but I'm not sure it's necessary to convince them. I like the flow after the removal.