Merge pull request #2 from chaoli2/update_readme_r3

update README for OpenVINO version information
intel · Dec 7, 2018 · 377b991 · 377b991
2 parents 71f8187 + 66a1491
commit 377b991
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Introduction
 The [OpenVINO™](https://software.intel.com/en-us/openvino-toolkit) toolkit quickly deploys applications and solutions that emulate human vision. Based on Convolutional Neural Networks (CNN), the Toolkit extends computer vision (CV) workloads across Intel® hardware, maximizing performance.
 
-This project is a ROS2 wrapper for CV API of [OpenVINO™](https://software.intel.com/en-us/openvino-toolkit), providing the following features:
+This project is a ROS wrapper for CV API of [OpenVINO™](https://software.intel.com/en-us/openvino-toolkit), providing the following features:
 * Support CPU and GPU platforms
 * Support standard USB camera and Intel® RealSense™ camera
 * Face detection
@@ -10,6 +10,10 @@ This project is a ROS2 wrapper for CV API of [OpenVINO™](https://software.inte
 * Head pose recognition
 * Demo application to show above detection and recognitions
 
-**Note**:We provide two ways to install the OpenVINO™ toolkit:<br>
-Install from Binary version [OpenVINO™](https://software.intel.com/en-us/openvino-toolkit) toolkit, please refer to [BINARY_VERSION_README.md](https://github.com/intel/ros_openvino_toolkit/blob/master/doc/BINARY_VERSION_README.md).<br>
+**Note**:  
+Only OpenVINO <b>R3</b> release is supported currently. See more from [Release Notes](https://software.intel.com/en-us/articles/OpenVINO-RelNotes).  
+
+**Note**:  
+Two methods are provided to install the OpenVINO™ toolkit:  
+Install from Binary version [OpenVINO™](https://software.intel.com/en-us/openvino-toolkit) toolkit, please refer to [BINARY_VERSION_README.md](https://github.com/intel/ros_openvino_toolkit/blob/master/doc/BINARY_VERSION_README.md).  
 Install from OpenVINO toolkit open source code, please refer to [OPEN_SOURCE_CODE_README.md](https://github.com/intel/ros_openvino_toolkit/blob/master/doc/OPEN_SOURCE_CODE_README.md)
diff --git a/doc/BINARY_VERSION_README.md b/doc/BINARY_VERSION_README.md
@@ -32,15 +32,15 @@ This project is a ROS wrapper for CV API of [OpenVINO™](https://software.intel
   3. Openvino: Download the install package, install_GUI.sh inside will check the GPU information before installation.
 
 ## 3. Environment Setup
-**Note**:You can choose to build the environment using *./environment_setup.sh* script in the script subfolder.
+**Note**:You can choose to build the environment using *./environment_setup_binary.sh* script in the script subfolder.
 ```bash
-./environment_setup_binary.sh hostname password
+./environment_setup_binary.sh username password
 ```
 **Note**:You can also choose to follow the steps below to build the environment step by step.
 
 - Install ROS Kinetic Desktop-Full ([guide](http://wiki.ros.org/kinetic/Installation/Ubuntu))
 
-- Install [OpenVINO™ Toolkit](https://software.intel.com/en-us/openvino-toolkit) ([guide](https://software.intel.com/en-us/articles/OpenVINO-Install-Linux))
+- Install [OpenVINO™ Toolkit](https://software.intel.com/en-us/openvino-toolkit) ([guide](https://software.intel.com/en-us/articles/OpenVINO-Install-Linux)). Choose "2018 R3" when download tarball.
 
 	**Note**: Please use  *root privileges* to run the installer when installing the core components.
 - Install OpenCL Driver for GPU

diff --git a/doc/OPEN_SOURCE_CODE_README.md b/doc/OPEN_SOURCE_CODE_README.md
@@ -37,7 +37,7 @@ This project is a ROS wrapper for CV API of [OpenVINO™](https://software.intel
 ## 3. Environment Setup
 **Note**:You can choose to build the environment using *./environment_setup.sh* script in the script subfolder.
 ```bash
-./environment_setup.sh hostname password
+./environment_setup.sh username password
 ```
 **Note**:You can also choose to follow the steps below to build the environment step by step.
 - Install ROS Kinetic Desktop-Full [(guide)](http://wiki.ros.org/kinetic/Installation/Ubuntu)

diff --git a/script/environment_setup.sh b/script/environment_setup.sh
@@ -5,9 +5,9 @@ set -euxo pipefail
 if [[ -n "$1" && -n "$2" ]]; then
 	HOST_NAME=$1
 	ROOT_PASSWD=$2
-	echo "set sudo password to $ROOT_PASSWD and your hostname is $HOST_NAME"
+	echo "set sudo password to $ROOT_PASSWD and your username is $HOST_NAME"
 else
-        echo "you have to input your hostname and sudo password!"
+        echo "you have to input your username and sudo password!"
         echo "    for example:./environment_setup.sh username password"
 	exit
 fi

diff --git a/script/environment_setup_binary.sh b/script/environment_setup_binary.sh
@@ -5,9 +5,9 @@ set -euxo pipefail
 if [[ -n "$1" && -n "$2" ]]; then
 	HOST_NAME=$1
 	ROOT_PASSWD=$2
-	echo "set sudo password to $ROOT_PASSWD and your hostname is $HOST_NAME"
+	echo "set sudo password to $ROOT_PASSWD and your username is $HOST_NAME"
 else
-        echo "you have to input your hostname and sudo password!"
+        echo "you have to input your username and sudo password!"
         echo "    for example:./environment_setup.sh username password"
 	exit
 fi