Add some documentation.

Author: liske

README.md

@@ -0,0 +1,23 @@
+# Python APDS-9960 Library
+
+Python library for the APDS-9960 gesture sensor developed while I was looking to get the APDS-9960 to work with a _Raspberry Pi_ to build a user interface feeling like in _Minority Report_.
+
+This library is a port of the [APDS-9960 Raspberry Pi Library](https://bitbucket.org/justin_woodman/apds-9960-raspberry-pi-library) of [Justin Woodman](https://justinwoodman.wordpress.com/2014/11/15/using-the-apds-9960-rgb-proximity-and-gesture-sensor-with-the-raspberry-pi-2/). Sadly his library is coded in C++ and seems not to be maintained any more.
+
+This library has been tested with [SparkFun RGB and Gesture Sensor - APDS-9960](https://www.sparkfun.com/products/12787) but should work with any other APDS-9960 based I²C device, too.
+
+Features:
+- operational voltage: 3.3V
+- ambient light & RGB color sensing
+- proximity sensing
+- gesture detection
+- operating range: 10 - 20cm
+- I²C interface (hard wired I²C address: 0x39)
+
+Documentation:
+- [RPi](RASPBERRY.md) - connect and configure the APDS-9960 on Raspberry Pi
+- Example scripts:
+  - [test-ambient](test-ambient) - simple ambient light level demo
+  - [test-gesture](test-gesture) - simple gesture detection demo
+  - [test-prox](test-prox) - simple proximity level demo
+  

RPi.md

@@ -0,0 +1,48 @@
+# APDS-9960 on Raspberry Pi
+
+## Wiring
+
+The APDS-9960 can be connected to the I²C bus of the RPi using the P01 header:
+
+| Board Pin | Function     |  RPi Pin | RPi Function   |
+|-----------|--------------|----------|----------------|
+| VL        | IR LED Power _(optional)_ |  n.c.    | _(not connected)_
+| GND       | Ground       |  P01-9   | GND
+| VCC       | +3.3V        |  P01-1   | 3.3V PWR
+| SDA       | Data         |  P01-3   | I2C1 SDA
+| SCL       | Clock        |  P01-5   | I2C1 SCL
+| INT       | Interrupt    |  P01-7   | GPIO 4 _(optional)_
+
+
+## I²C
+
+You need to have enabled loading of the I²C kernel module. You might use `raspi-config` to enable I²C:
+- run `raspi-config`
+- select `5 Interfacing Options`
+- enable `P5 I2C`
+
+The APDS-9960 supports a I²C clock up to 400KHz (default is 100KHz). To speed up detection performance you should increase the clock rate be using the following option in `/boot/config.txt`:
+
+```
+dtparam=i2c_arm=on,i2c_baudrate=400000
+```
+
+A reboot is required to apply the change.
+
+
+## Verify
+
+To verify your setup use the `i2cdetect` command. The APDS-9960 chip is hard coded at the address 0x39:
+
+```shell
+# i2cdetect -y 1                                                    
+     0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f                             
+00:          -- -- -- -- -- -- -- -- -- -- -- -- --                             
+10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --                             
+20: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --                             
+30: -- -- -- -- -- -- -- -- -- 39 -- -- -- -- -- --                             
+40: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --                             
+50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --                             
+60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --                             
+70: -- -- -- -- -- -- -- --                                                     
+```