1 files changed, 14 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..75695e8
--- /dev/null
+++ b/README
@@ -0,0 +1,14 @@
+-*- org -*-
+
+Guile-GPIO provides a convenient Guile interface to the Linux GPIO
+Sysfs API.  It abstracts away all of the details regarding the GPIO
+file system and allows the programmer to focus on writing userspace
+GPIO drivers rather than fiddling with file descriptors.
+
+#+BEGIN_SRC scheme
+  (use-modules (gpio))
+
+  (with-pins ((pin1 1 #:direction 'in #:edge 'falling)
+              (pin3 3 #:direction 'out))
+    (pin-set! pin3 #t))
+#+END_SRC