Update readme to support mac osx
[remote-debug.git] / README.md
index e14e5cd..54a45ab 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,6 +7,13 @@
     - run `./add-user.sh` to create a user, used for remote ssh, named debug, and its password is suanzikeji 
     - run `./install.sh` to install the daemon and service file
 
+- On local machine
+    - Linux,  run `apt-get install sshpass`
+    - Mac OSX, sshpass is not in brew. To install this, 
+        - `brew create https://sourceforge.net/projects/sshpass/files/sshpass/1.05/sshpass-1.05.tar.gz --force`
+        - `brew install sshpass`
+    - run `pip install paho-mqtt`
+
 ## Usage
 
 ### list all connected device
@@ -31,6 +38,21 @@ timeout
 
 The output
 
+
+```
+debian@[~/project/remote-ssh]>> ./sztool list                                                                                                                                                                                  
+Mac:  080027a6f8dc
+
+Found 3 connected devices:
+Connected with result code 0
+
+ Device ID              Data
+------------------------------
+00044b8d6310            OK
+502b73d42c31            OK
+b0f1ec7a62ce            OK
+```
+
 ```
 debian@[~/project/remote-ssh]>> ./sztool connect 2acdeb93b285                                                                                                                                                                 
 Mac:  080027a6f8dc