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 README.md #50

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ listed on the TODO list. Suggestions and contributions are welcome.
* Windows 7+ (for now)
* [Docker Machine](https://docs.docker.com/machine/) 0.5.0+
* [VMware Workstation](https://www.vmware.com/products/workstation) Workstation Free/Pro 10 +
* WSL (Windows Subsystem for Linux) or Git Bash

## Installation

Expand All @@ -54,7 +55,7 @@ add it to your $PATH.
```none
#!/bin/bash

export PATH="$PATH:/mnt/c/Program Files (x86)/VMware/VMware Workstation"
   export PATH="$PATH:/mnt/c/Program Files (x86)/VMware/VMware Workstation"
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to be causing a break in the codeblock. Could you verify?


trap '[ "$?" -eq 0 ] || read -p "Looks like something went wrong in step ´$STEP´... Press any key to continue..."' EXIT

Expand All @@ -71,7 +72,7 @@ add it to your $PATH.
exit 1
fi

vmrun.exe list | grep \""${VM}"\" &> /dev/null
vmrun.exe list | grep "${VM}" &> /dev/null
VM_EXISTS_CODE=$?

set -e
Expand Down Expand Up @@ -141,6 +142,22 @@ add it to your $PATH.

## Usage

Usage `WSL (Windows Subsystem for Linux)` can be perfect to run this scripts, otherwise you can only modify the script after using `Git Bash` to run.
So you'd better install and use `WSL` to run scripts.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this section is not that clear, maybe we can rephrase?

WSL (Windows Subsystem for Linux)is a perfect option to run this script otherwise, you can modify the scripts as outlined below to run with otherbashtools likeGit BashorMSYS2`

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can write two script files for WSL (Windows Subsystem for Linux) and Git Bash, or try to write a script file that is compatible with both.
This is WSL:
image
This is Git Bash:
image
There are some differences between the two.
The differences I have known are: path problems.
In the WSL: /mnt/c/xxxxx.
In the Git Bash: /c/xxxxx.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I know both, the main difference for this is just the mount path, that is all. It might be better to script the detection of the environment than to have 2 scripts.


#### Three ways:
1. `Win + R` Combination key, Open `Run` window.
Enter & Run `bash` command.
Enter & Run `C:\Program Files\Docker Toolbox\start.sh` in `bash` window.

2. Change `export PATH="$PATH:/mnt/c/Program Files (x86)/VMware/VMware Workstation"` to `export PATH="$PATH:/c/Program Files (x86)/VMware/VMware Workstation"` in `start.sh`.
  Find `Docker Quickstart Terminal` on the desktop and double-click to run(need installed `Git Bash`).
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(requires Git Bash)

could be better there, wdyt?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The better reason for WSL is that it is more convenient and quicker.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, i meant change the text to

(requires Git Bash)

instead of

need installed


3. Change `export PATH="$PATH:/mnt/c/Program Files (x86)/VMware/VMware Workstation"` to `export PATH="$PATH:/c/Program Files (x86)/VMware/VMware Workstation"` in `C:\Program Files\Docker Toolbox\start.sh`.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both for 2. and 3. could we break the export [...] commands to multiple lines to make it more readable?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dont really see the difference between 2. and 3. could you explain?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Usage WSL:
    Run directly using your script file.
  2. Usage Git Bash:
    After modifying the script file, run Docker Quickstart Terminal on the desktop directly.
    OR
    After modifying the script file, run Git Bash directly and Enter C:\Program Files\Docker Toolbox\start.sh in the Git Bash window.

  Find `Git Bash` on the desktop and double-click to run.
  Enter `"C:\Program Files\Docker Toolbox\start.sh"` run in `Git Bash`.


Official documentation for Docker Machine is available
[here](https://docs.docker.com/machine/).

Expand Down