libgpiod: add a simple README
authorBartosz Golaszewski <bartekgola@gmail.com>
Mon, 2 Jan 2017 10:44:35 +0000 (11:44 +0100)
committerBartosz Golaszewski <bartekgola@gmail.com>
Mon, 2 Jan 2017 10:44:35 +0000 (11:44 +0100)
Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..6a13e7c
--- /dev/null
+++ b/README
@@ -0,0 +1,11 @@
+    libgpiod - C library and tools for interacting with the linux GPIO
+               character device
+
+Since linux 4.7 the GPIO sysfs interface is deprecated. User space should use
+the character device instead. This library encapsulates the ioctl calls and
+data structures behind a straightforward API.
+
+This is still work-in-progress and no interfaces are stable yet.
+
+Contributions are welcome - please use github pull-requests and stick to the
+linux kernel coding style.