From bc75383559951b1ccba62f65ffa5a36e91a44247 Mon Sep 17 00:00:00 2001
From: Marek Kubica <marek@xivilization.net>
Date: Sun, 6 Jul 2014 23:43:00 +0200
Subject: [PATCH] New readme with new build instructions.

---
 README.md  | 17 +++++++++++++++++
 README.org | 12 ------------
 2 files changed, 17 insertions(+), 12 deletions(-)
 create mode 100644 README.md
 delete mode 100644 README.org

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e9e166f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+WiringPi for OCaml
+==================
+
+A binding for the [WiringPi](http://wiringpi.com/) library for
+[OCaml](http://ocaml.org/).
+
+Build
+-----
+
+You need to have [OASIS](http://oasis.forge.ocamlcore.org/), the best way to
+get it is to use [OPAM](http://opam.ocaml.org/).
+
+```sh
+oasis setup
+ocaml setup.ml -configure
+ocaml setup.ml -build
+```
diff --git a/README.org b/README.org
deleted file mode 100644
index 9f83b02..0000000
--- a/README.org
+++ /dev/null
@@ -1,12 +0,0 @@
-* Use
-To use it just run
-: make
-and then
-: sudo ./sapin_noel.bin
-
-* Goal
-This script uses the wiringPi library http://wiringpi.com/ (thank you for your job) and adapts it in order to make it usable in Ocaml. Most common functions are implemented (see wiringPiOcaml.ml) but lot's of functions aren't present for the moment. It's very simple to add these functions, so you can add them and if you want I can add your modifications.
-
-There is too a little script to use shift registers, and an example file named sapin_noel.ml.
-
-Enjoy !