Merge pull request #9 from sickcodes/readme-edits

Add instructions for Linux and PATH issue for systems without /usr/lo…

Author: strazzere

README.md

@@ -10,8 +10,9 @@ Installation
 
 Copy usbfluxd binary to a location included in $PATH, for example
 /usr/local/sbin:
-```
+```zsh
 sudo cp usbfluxd /usr/local/sbin/
+export PATH=/usr/local/sbin:${PATH}
 ```
 
 Usage
@@ -21,7 +22,7 @@ Note: usbfluxd requires root permissions to run.
 
 To start usbfluxd, run:
 
-```
+```zsh
 sudo usbfluxd
 ```
 
@@ -32,16 +33,16 @@ and also with increased verbosity by adding -v to the command line. Multiple
 Please be aware that all usbmuxd-aware apps like Xcode or iTunes need to be
 restarted so they will talk to usbfluxd instead of the original usbmuxd.
 
+To stop usbfluxd immediately, run:
 
-To stop usbfluxd, run:
-
-```
+```zsh
 sudo killall usbfluxd
 ```
 
 Also after stopping usbfluxd, remember to restart any app that relies on
 usbmuxd so it returns to the original state.
 
+On Linux you may need to `sudo systemctl restart usbmuxd`.
 
 
 Build Requirements
@@ -65,8 +66,55 @@ Installation From Source
 ========================
 
 To compile run:
-```
+```zsh
+# brew install make autoheader automake autoconf libtool pkg-config gcc libimobiledevice
+
+git clone https://github.com/corellium/usbfluxd.git
+cd usbfluxd
+
 ./autogen.sh
 make
 sudo make install
 ```
+
+Also available from the Arch User Repository for Linux hosts: [https://aur.archlinux.org/packages/usbfluxd/](https://aur.archlinux.org/packages/usbfluxd/)
+
+
+Linux Usage
+===========
+
+Connecting your device over USB on Linux allows you to expose usbfluxd on port 5000 to another system on the same network.
+
+Ensure `usbmuxd`, `socat` and `usbfluxd` are installed.
+
+Start the `usbmuxd` daemon on Linux
+```bash
+sudo systemctl start usbmuxd
+```
+
+Start `avahi-daemon` for small-scale mDNS
+```bash
+sudo avahi-daemon
+```
+
+Start `usbfluxd` in the foreground
+```bash
+sudo usbfluxd -f -n
+```
+
+Expose `/var/run/usbmuxd` on port `5000`
+```bash
+sudo socat tcp-listen:5000,fork unix-connect:/var/run/usbmuxd
+```
+
+Choose any IP address from `ip addr` as the source.
+
+### Connect to a host running usbfluxd
+
+From the remote host (catch the remote usbfluxd and make it appear local).
+
+```zsh
+# on the destination
+export PATH=/usr/local/sbin:${PATH}
+sudo usbfluxd -f -r 10.0.0.2:5000
+```