Tweak text to cover all OSs
[arvados-vscode-cwl-training.git] / README.md
index 0b932abe427b56f161d8477bdf1571c1246dc94e..33d60842f72905efce49dab48d69c11e2d3d5f88 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,18 +10,20 @@ Code (abbreviated "vscode") to develop CWL workflows on Arvados.
 
 ## 1. SSH Setup
 
-1. (Windows only) Install git for windows [https://git-scm.com/download/win](https://git-scm.com/download/win)
+1. (Windows only) Install Git for Windows [https://git-scm.com/download/win](https://git-scm.com/download/win)
    1. Choose "64-bit Git for Windows Setup".  It does not require admin privileges to install.
    1. Hit "Next" a bunch of times to accept the defaults
-   1. The most important things is that "install git bash" and "install OpenSSH" are enabled.
+   1. The most important things is that "install git bash" and "install OpenSSH" are enabled (this is the default).
    1. At the end of the installation, you can launch tick a box to git bash directly.
    1. Open "Git Bash" (installed in the "Git" folder of the start menu)
-1. From an open bash shell
+1. (All operating systems) Starting from bash shell (on MacOS or Linux you will open "Terminal")
    1. Shell: Run `ssh-keygen`
       1. Hit enter to save to a default location
       1. You can choose to protect the key with a password, or just hit enter for no password.
-   1. Shell: Look for a message like `Your public key has been saved in /c/Users/MyUsername/.ssh/id_rsa.pub`
-   1. Shell: Run `cat /c/Users/MyUsername/.ssh/id_rsa.pub`
+   1. Shell: Look for a message like `Your public key has been saved
+      in /c/Users/MyUsername/.ssh/id_rsa.pub` (Windows git bash
+      example, on MacOS or Linux this will probably start with `/Users` or `/home`)
+      1. Shell: Run `cat /c/Users/MyUsername/.ssh/id_rsa.pub`
    1. Shell: Use the pointer to highlight and copy the lines starting
       with `ssh-rsa …` up to the next blank line.  Right click and
       select "Copy"
@@ -174,7 +176,7 @@ The `message` parameter will be taken from the file `lesson4/main-input.yaml`.
 1. Vscode: In the bottom panel select the `Terminal` tab
    1. In the upper right corner of the Terminal tab select `Task - Run CWL Workflow` from the drop-down
    1. Look for logging text like `submitted container_request zzzzz-xvhdp-0123456789abcde`
-   1. Highlight and copy the workflow identifier (this the string containing -xvhdp- in the middle)
+   1. Highlight and copy the workflow identifier (this the string containing `-xvhdp-` in the middle)
    1. The results of this run will appear in the terminal when the run completes.
 1. Workbench: Paste the workflow identifier into the search box
    1. This will take you to the status page for this workflow