[incubator-openwhisk] branch master updated: Updated README.MD to reflect the need for Windows users to install SSH if not already installed. (#2335)

[cs...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

csantanapr pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-openwhisk.git


The following commit(s) were added to refs/heads/master by this push:
     new 7e5b1b1  Updated README.MD to reflect the need for Windows users to install SSH if not already installed. (#2335)
7e5b1b1 is described below

commit 7e5b1b12c0309583769f26117a5c972d8da63019
Author: Brandon Lee Underwood <Br...@ibm.com>
AuthorDate: Wed Aug 2 20:58:09 2017 -0400

    Updated README.MD to reflect the need for Windows users to install SSH if not already installed. (#2335)
---
 README.md               | 2 ++
 tools/vagrant/README.md | 8 ++++----
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 4a000be..daf034b 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,8 @@ OpenWhisk is a cloud-first distributed event-based programming service. It provi
 A [Vagrant](http://vagrantup.com) machine is the easiest way to run OpenWhisk on Mac, Windows PC or GNU/Linux.
 Download and install [VirtualBox](https://www.virtualbox.org/wiki/Downloads) and [Vagrant](https://www.vagrantup.com/downloads.html) for your operating system and architecture.
 
+**Note:** For Windows, you may need to install an ssh client in order to use the command `vagrant ssh`. Cygwin works well for this, and Git Bash comes with an ssh client you can point to. If you run the command and no ssh is installed, Vagrant will give you some options to try.
+
 Follow these step to run your first OpenWhisk Action:
 ```
 # Clone openwhisk
diff --git a/tools/vagrant/README.md b/tools/vagrant/README.md
index 7cd7a5a..fb2476b 100644
--- a/tools/vagrant/README.md
+++ b/tools/vagrant/README.md
@@ -5,7 +5,7 @@ The following instructions were tested on Mac OS X El Capitan, Ubuntu 14.04.3 LT
 *Requirements*
 - Install [VirtualBox](https://www.virtualbox.org/wiki/Downloads) (tested with version 5.1.22)
 - Install [Vagrant](https://www.vagrantup.com/downloads.html) (tested with version 1.9.5)
- 
+
 ### Clone the repository and change directory to `tools/vagrant`
 ```
 git clone --depth=1 https://github.com/apache/incubator-openwhisk.git openwhisk
@@ -47,7 +47,7 @@ wsk action invoke /whisk.system/utils/echo -p message hello --result
     "message": "hello"
 }
 ```
-**Tip:** The very first build may take 30 minutes or more depending on network speed. 
+**Tip:** The very first build may take 30 minutes or more depending on network speed.
 If there are any build failures, it might be due to network timeouts, to recover follow the manual
 process to build and deploy in [ansible/README.md](../../ansible/README.md)
 
@@ -87,7 +87,7 @@ You do not need to use the `-i` switch to `wsk` now. Note, however, that `wsk sd
 
 
 **Note:** To connect to a different host API (i.e. bluemix.net) with the CLI, you will need to configure the CLI with new values for __apihost__, and __auth__ key.
- 
+
 ### Use the wsk CLI inside the VM
 For your convenience, a `wsk` wrapper is provided inside the VM which delegates CLI commands to `$OPENWHISK_HOME/bin/linux/amd64/wsk` and adds the `-i` parameter that is required for insecure access to the local OpenWhisk deployment.
 
@@ -226,6 +226,6 @@ Create VM with Desktop GUI. The `username` and `password` are both set to `vagra
   gui=true ./hello
   gui=true vagrant reload
 ```
-**Tip**: Ignore error message `Sub-process /usr/bin/dpkg returned an error code (1)` when 
+**Tip**: Ignore error message `Sub-process /usr/bin/dpkg returned an error code (1)` when
 creating Vagrant VM using `gui-true`. Remember to use `gui=true` every time you do `vagrant reload`.
 Or, you can enable the GUI directly by editing the Vagrant file.

-- 
To stop receiving notification emails like this one, please contact
['"commits@openwhisk.apache.org" <co...@openwhisk.apache.org>'].