From 42478469a346f30aa366874bfe7ffb9d52b4e1d3 Mon Sep 17 00:00:00 2001
From: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Date: Wed, 21 Feb 2018 13:44:01 +0100
Subject: [PATCH] README.rst: convert to ReST and add details

* Convert the README file to reStructuredText (ReST)
* Add more details (such as build dependencies) for Fedora 27

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
---
 README     | 18 -------------
 README.rst | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 76 insertions(+), 18 deletions(-)
 delete mode 100644 README
 create mode 100644 README.rst

diff --git a/README b/README
deleted file mode 100644
index 0bd26a0f3..000000000
--- a/README
+++ /dev/null
@@ -1,18 +0,0 @@
-BUILD DEPENDANCE 
-
-	for CentOS
-	yum install libuuid-devel
-
-BUILD
-	make
-
-CLEAN
-	make clean
-
-
-RUN DEPENDANCE
-
-	for CentOS
-	yum install openssl-libs
-	yum install zlib
-	yum install libuuid
diff --git a/README.rst b/README.rst
new file mode 100644
index 000000000..4b48f0955
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,76 @@
+ACRN Device Model
+#################
+
+Introduction
+============
+The ACRN Device Model provides **device sharing** capabilities between the Service OS and Guest OSs. It is a component that is used in conjunction with the `ACRN Hypervisor`_ and this is installed within the Service OS. You can find out more about Project ACRN on the `Project ACRN documentation`_ website.
+
+
+Building the Device Model
+=========================
+
+Build dependencies
+******************
+
+* For Clear Linux
+
+.. code-block:: console
+
+   sudo swupd bundle-add os-clr-on-clr \
+          os-utils-gui-dev
+
+* For CentOS
+
+.. code-block:: console
+
+   sudo yum install gcc \
+          libuuid-devel \
+          openssl-devel \
+          libpciaccess-devel
+
+* For Fedora 27
+
+.. code-block:: console
+
+   sudo dnf install gcc \
+          libuuid-devel \
+          openssl-devel \
+          libpciaccess-devel
+
+Build
+*****
+To build the Device Model
+
+.. code-block:: console
+
+   make
+
+To clean the build artefacts
+
+.. code-block:: console
+
+   make clean
+
+Runtime dependencies
+********************
+
+* On CentOS
+
+.. code-block:: console
+
+   sudo yum install openssl-libs \
+                    zlib \
+                    libpciaccess \
+                    libuuid
+
+* On Fedora 27
+
+.. code-block:: console
+
+   sudo dnf install openssl-libs \
+                    zlib \
+                    libpciaccess \
+                    libuuid
+
+.. _`ACRN Hypervisor`: https://github.com/projectacrn/acrn-hypervisor
+.. _`Project ACRN documentation`: https://projectacrn.github.io/