[incubator-streampipes-installer] branch new_installer updated: [STREAMPIPES-196] updates to README

[wi...@apache.org]

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

wiener pushed a commit to branch new_installer
in repository https://gitbox.apache.org/repos/asf/incubator-streampipes-installer.git


The following commit(s) were added to refs/heads/new_installer by this push:
     new 148a344  [STREAMPIPES-196] updates to README
148a344 is described below

commit 148a344bdd4341b26e03026d8e10b4c3ade44814
Author: Patrick Wiener <wi...@fzi.de>
AuthorDate: Mon Aug 17 20:29:54 2020 +0200

    [STREAMPIPES-196] updates to README
---
 cli/README.md     | 12 ++++++++----
 compose/README.md |  2 +-
 2 files changed, 9 insertions(+), 5 deletions(-)

diff --git a/cli/README.md b/cli/README.md
index c73d644..3dac48a 100644
--- a/cli/README.md
+++ b/cli/README.md
@@ -52,12 +52,12 @@ The CLI is basically a wrapper around multiple `docker` and `docker-compose` com
 
 * Docker >= 17.06.0
 * Docker-Compose >= 1.17.0 (Compose file format: 3.4)
-* On Windows hosts: GitBash
+* For Windows Developer: GitBash only
 
 
 Tested on: **macOS**, **Linux**, **Windows***)
 
-> **NOTE**: *) If you're using Windows the CLI only works in combination with GitBash - PowerShell won't work.
+> **NOTE**: *) If you're using Windows the CLI only works in combination with GitBash - CMD, PowerShell won't work.
 
 
 ## Usage: Along dev life-cycle
@@ -115,13 +115,17 @@ streampipes clean
 ```
 
 ## Run `streampipes` from anywhere? No problem
-Simply add the path the cli directory to your `$PATH` variable, e.g. in your `.bashrc` or `.zshrc`
-> **NOTE**: So far, only tested on **macOS** and **Linux**.
+Simply add the path to this cli directory to your `$PATH` (on macOS, Linux) variable, e.g. in your `.bashrc` or `.zshrc`, or `%PATH%` (on Windows).
+
+For **macOS**, or **Linux**:
 
 ```bash
 export PATH="/path/to/incubator-streampipes-installer/cli:$PATH"
 ```
 
+For **Windows 10**, e.g. check this [documentation](https://helpdeskgeek.com/windows-10/add-windows-path-environment-variable/).
+
+
 ## Upgrade to new version
 To upgrade to a new version, simply edit the version tag in `VERSION`.
 
diff --git a/compose/README.md b/compose/README.md
index 7b2f18e..f6ebcbe 100644
--- a/compose/README.md
+++ b/compose/README.md
@@ -33,7 +33,7 @@ Go to http://localhost to finish the installation in the browser.
 * Docker >= 17.06.0
 * Docker-Compose >= 1.17.0 (Compose file format: 3.4)
 
-Tested on: **macOS, Linux, Windows**
+Tested on: **macOS, Linux, Windows** (CMD, PowerShell, GitBash)
 
 > **NOTE**: On purpose, we disabled all port mappings except of http port **80** to access the StreamPipes UI to provide minimal surface for conflicting ports.