Update To 11.40.268.0

[platform/framework/web/crosswalk.git] / src / third_party / webrtc / tools / rtcbot / README

diff --git a/src/third_party/webrtc/tools/rtcbot/README b/src/third_party/webrtc/tools/rtcbot/README
index 8b5bab1..1f4d7c1 100644 (file)
--- a/src/third_party/webrtc/tools/rtcbot/README
+++ b/src/third_party/webrtc/tools/rtcbot/README
@@ -17,12 +17,20 @@ access its exposed API. Details are in botmanager.js.
 == How to run the test ==
  $ cd trunk/webrtc/tool/rtcbot
  $ npm install express browserify ws websocket-stream dnode
- $ node test.js <bot_type> <test_file_path>
+ $ mkdir configurations
+ $ cd configurations
+ $ openssl genrsa -out priv.pem 1024
+ $ openssl req -x509 -new -key priv.pem -days 3650 -out cert.crt
+ $ cd trunk/webrtc/tool/rtcbot
+ $ node main.js "<test_name>"
+
+* Note:
+    In first time you will use rtcBot you will receive a warning telling
+  you that your connection is not private. Just avoid this warning and
+  click Proceed to localhost (unsafe).
 
- <bot_type> — the type of the running bot. For example:
-  - chrome: chrome on host machine.
-  - android: android device. Details in "Android" Section.
-  - android-chrome: chrome on android device. Details in "Android" Section.
+== How can I see the list of available tests? ==
+ $ node main.js
 
 == Example on how to install nodejs ==
  $ cd /work/tools/
@@ -31,6 +39,16 @@ access its exposed API. Details are in botmanager.js.
  $ nvm install 0.10
  $ nvm use 0.10
 
+== Why generating the private key and self signed certificate? ==
+  - Private key and certificate are used for creating HTTPs server in
+    rtcBot for loading the required files on the different types of the bots.
+
+== Supported Bot Types ==
+  - "chrome": chrome on host machine.
+  - "android-chrome": chrome on android device. Details in "Android" Section.
+
+ * Bot type is specified directly by the test.
+
 == Android ==
 Before running test with Android one MUST forward the device port 8080 to the
 host machine. That is easy to achieve with chrome port forwarding tools.