summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNick Van Doorn <vandoorn.nick@gmail.com>2017-12-04 21:01:49 -0800
committerNick Van Doorn <vandoorn.nick@gmail.com>2017-12-04 21:01:49 -0800
commit1a824a826d86acce85289afb90914d7f66687f2d (patch)
tree3ffd25daeb0d6696c6061b8e0b6005527e4c24c2 /README.md
parent8cd0fb5993f60021904c47c864c1e94aeeebe1cf (diff)
Update license and readme to give proper credit
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 19 insertions, 2 deletions
diff --git a/README.md b/README.md
index 6bea0c9..cd7fc51 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,26 @@
# VC0706-cam-lib-legato
-Library for the Adafruit VC0706 camera used on Legato devices. The majority of this code is ported from Adafruit's [Adafruit-VC0706-Serial-Camera-Library](https://github.com/adafruit/Adafruit-VC0706-Serial-Camera-Library) repository with some C/Legato specific changes.
+Library for the Adafruit VC0706 camera used on Legato devices.
+
+## Credit
+The majority of this code is ported from Adafruit's [Adafruit-VC0706-Serial-Camera-Library](https://github.com/adafruit/Adafruit-VC0706-Serial-Camera-Library) repository with some C/Legato specific changes.
+
+This is a library for the Adafruit TTL JPEG Camera (VC0706 chipset)
+
+Pick one up today in the adafruit shop!
+------> http://www.adafruit.com/products/397
+
+These displays use Serial to communicate, 2 pins are required to interface
+
+Adafruit invests time and resources providing this open source code,
+please support Adafruit and open-source hardware by purchasing
+products from Adafruit!
+
+Original code written by Limor Fried/Ladyada for Adafruit Industries.
+BSD license, all text above must be included in any redistribution
## Project Status
-Still incomplete and not functional. We are hoping to release 1.0.0 in the coming days.
+Still incomplete and not functional. We are currently experiencing some issues reading a complete image off the camera after taking a photo. The code is currently riddled with debug log statements but these will be cleaned up prior to release `1.0.0`
## Usage on Other Platforms
The Legato serial API [`le_tty`](http://legato.io/legato-docs/latest/le__tty_8h.html) returns a file descriptor used to read and write. The file descriptor in the `Camera` struct can be replaced with any other file descriptor serial interface.