From 851ff3e1283153b6071de6912f955bfaac8a25b9 Mon Sep 17 00:00:00 2001
From: BERTHAUT Florent <florent.berthaut@univ-lille1.fr>
Date: Mon, 25 Jun 2018 15:54:15 +0200
Subject: [PATCH] Updated the readme

---
 README    | 39 ---------------------------------------
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 40 insertions(+), 39 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index b2c2095..0000000
--- a/README
+++ /dev/null
@@ -1,39 +0,0 @@
-ControlAR
-
-Description:
-
-Authors:
-    Florent Berthaut, Assistant Professor, University Lille 3, CRIStAL/MINT
-    florent_AT_hitmuri_DOT_net 
-
-Compiling/Running on GNU/Linux: 
-    *Install the following packages: 
-        g++ (or gcc-c++) 
-        libfltk-dev
-        libxml2-dev
-        libX11-dev
-        libxcb-dev
-        libportmidi
-    *Run the following commands from the controlar folder:
-        ./waf configure
-        ./waf
-        ./build controlar
-
-Compiling/Running on OSX: 
-    *Install MacPorts : http://www.macports.org/
-    *Run the following commands from a terminal :
-        port install gcc5
-        port install fltk
-        port install libxml2
-        port install portmidi
-    *Run the following commands from the controlar folder:
-        ./waf configure
-        ./waf
-        ./build controlar (or open the controlar.app in the build folder)
-
-Installing on the system: 
-    *Run the following command
-        sudo ./waf install
-
-
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9b90cdf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# ControlAR
+
+## Description:
+
+ControllAR is a system that facilitates the appropriation of rich visual feedback on control surfaces through remixing of graphical user interfaces and augmented reality display. A video example of the use of ControllAR can be seen on : https://vimeo.com/182821251
+
+## Compiling/Running on GNU/Linux: 
+* Install the following packages: 
+    g++ (or gcc-c++) 
+    libfltk-dev
+    libxml2-dev
+    libX11-dev
+    libxcb-dev
+    libportmidi
+* Run the following commands from the controlar folder:
+    ./waf configure
+    ./waf
+    ./build controlar
+* To install : 
+    sudo ./waf install
+
+## Compiling/Running on OSX: 
+* Install MacPorts : http://www.macports.org/
+* Run the following commands from a terminal :
+    port install gcc5
+    port install fltk
+    port install libxml2
+    port install portmidi
+* Run the following commands from the controlar folder:
+    ./waf configure
+    ./waf
+    ./build controlar (or open the controlar.app in the build folder)
+
+## Installing on the system: 
+* Run the following command
+
+## Authors:
+Florent Berthaut, Assistant Professor, University Lille 3, CRIStAL/MINT
+florent_AT_hitmuri_DOT_net 
+
-- 
GitLab