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

Getting Started minor fix for $MODDABLE to %MODDABLE% for Windows #510

Closed

Conversation

cmidgley
Copy link
Contributor

@cmidgley cmidgley commented Dec 9, 2020

Trivial update to the Getting Started doc - it had $MODDABLE in the Update section for Windows rather than %MODDABLE%

@andycarle
Copy link
Member

Hi @cmidgley,

Thank you for the suggestion! I'm not sure this is exactly the right change to make, but I agree that this portion of the instructions may be too confusing.

That step in the Getting Started guide assumes that the user is working in Git Bash ("For instance, using Git Bash:"). The Git Bash tool, annoyingly, does not accept the Windows-conventional %VAR% notation. It instead uses the Linux-conventional $VAR.

I think those instructions date to a time before it was common to install the Git Command Prompt integration on Windows, so we assumed everyone was using Git Bash. Perhaps the right fix at this point is to remove all mentions of Git Bash and the $ syntax from the Windows instructions, assuming that people are using the Command Prompt integration instead.

I personally still use Git Bash, but I'm curious what the rest of the world is up to. @cmidgley, what tool do you personally use for managing git repos at the command line on Windows?

 - Andy

@cmidgley
Copy link
Contributor Author

cmidgley commented Dec 9, 2020

I did not catch that - my bad! I generally just use the "x86 Native Tools Command Prompt for VS 2019", or standard Windows CMD shell with environment vars. I rarely use Git Bash, as I do almost all work in either the basic Windows shell, or in VS Code (no shell). My preferred mode is to integrate everything into VS Code so I don't even need to use the shell at all. I'm hoping to work out how to do that in the coming weeks (including Intellisense). I believe others have succeeded but I've not seen a write up yet.

This can be closed, as it is clearly correct and I just skipped over the detailed instructions! Appreciate the feedback.

@cmidgley cmidgley closed this Dec 9, 2020
@cmidgley cmidgley deleted the get-started-doc branch December 29, 2020 02:15
mkellner pushed a commit that referenced this pull request May 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants