Create README.md

README.md

@@ -0,0 +1,63 @@
+# CastScreen
+Cast Android screen via WiFi or USB
+
+## Requirments
+* Gstreamer 1.0 with H264 decoder (h264parse, avdec_h264) 
+* adb for mirror via USB
+
+## With native receiver
+* Compile the receiver
+```
+$ cd receiver
+$ make
+```
+### Via WiFi
+1. Launch receiver
+```
+$ cd receiver
+$ ./cs_receiver autovideosink
+```
+2. Open CastScreen APP
+3. Wait the receiver to appear on the list
+4. Select the receiver
+5. Tap **Start** on right corner
+
+### Via USB
+1. Enable debug mode on the Android device
+2. Make sure adb is available on your PC
+3. Open CastScreen APP
+4. Select **Server mode**
+5. Tap **Start** on right corner
+6. Launch receiver
+```
+$ cd receiver
+$ ./wait_adb.sh
+```
+
+## With python receiver
+### Via WiFi
+1. Launch receiver
+```
+$ cd receiver
+$ python cs_receiver.py
+```
+2. Open CastScreen APP
+3. Wait the receiver to appear on the list
+4. Select the receiver
+5. Tap **Start** on right corner
+
+### Via USB
+1. Enable debug mode on the Android device
+2. Make sure adb is available on your PC
+3. Open CastScreen APP
+4. Select **Server mode**
+5. Tap **Start** on right corner
+6. Launch receiver
+```
+$ cd receiver
+$ adb forward tcp:53516 tcp:53515
+$ python cs_receiver_conn.py
+```
+
+## License
+Copyright (c) 2015-2016 Jones Chi. Code released under the Apache License.