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

Documentation error for updating on Windows #897

Closed
louisvangeldrop opened this issue Apr 8, 2022 · 2 comments
Closed

Documentation error for updating on Windows #897

louisvangeldrop opened this issue Apr 8, 2022 · 2 comments
Labels
fixed - please verify Issue has been fixed. Please verify and close.

Comments

@louisvangeldrop
Copy link

In the windows update documentation:
https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/Moddable%20SDK%20-%20Getting%20Started.md#win-update

The following error occurs:

Updating
The Moddable SDK tools are frequently updated with improvements and added functionality. You should occasionally update your host environment by following these steps:

Update your local clone of the Moddable repository. For instance, using Git Bash:

cd $MODDABLE : Should be %MODDABLE%
git pull
Note that if you have any local changes to Moddable repository files, you may need to stash your changes and then reapply them after pulling:

cd $MODDABLE: Should be %MODDABLE%
git stash push
git pull
git stash pop

@andycarle
Copy link
Member

Hi @louisvangeldrop,

Thank you for the suggestion.

Those particular instructions are written for updating with Git Bash ("For instance, using Git Bash:"), which uses the bash-like $ syntax for environment variables rather than the Windows %%.

That said, I agree that it is a little confusing that parts of the Windows instructions assume Git Bash and parts assume CMD. At the time they were written, Git integration with CMD was somewhat uncommon — now I think more people are using that model than using Git Bash.

I will take a pass at some point and drop the Git Bash pieces from the install/update flows.

Cheers!
 - Andy

@louisvangeldrop
Copy link
Author

You are welcome.

@phoddie phoddie changed the title Moddable documenation Windows update error Documentation error for updating on Windows Apr 8, 2022
mkellner pushed a commit that referenced this issue May 5, 2022
@phoddie phoddie added the fixed - please verify Issue has been fixed. Please verify and close. label Jun 3, 2022
@phoddie phoddie closed this as completed Jun 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fixed - please verify Issue has been fixed. Please verify and close.
Projects
None yet
Development

No branches or pull requests

3 participants