Tweak text to cover all OSs
authorPeter Amstutz <peter.amstutz@curii.com>
Tue, 9 Feb 2021 18:51:16 +0000 (13:51 -0500)
committerPeter Amstutz <peter.amstutz@curii.com>
Mon, 15 Feb 2021 21:28:45 +0000 (16:28 -0500)
Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

README.md

index 5ceac78034f23ee30ab14af603e27e0e81ab7fa5..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"