Skip to content

Commit 32fbc35

Browse files
Geoffroy Van Cutsemlijinxia
authored andcommitted
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>
1 parent 4b3ebb3 commit 32fbc35

File tree

2 files changed

+76
-18
lines changed

2 files changed

+76
-18
lines changed

devicemodel/README

Lines changed: 0 additions & 18 deletions
This file was deleted.

devicemodel/README.rst

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
ACRN Device Model
2+
#################
3+
4+
Introduction
5+
============
6+
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.
7+
8+
9+
Building the Device Model
10+
=========================
11+
12+
Build dependencies
13+
******************
14+
15+
* For Clear Linux
16+
17+
.. code-block:: console
18+
19+
sudo swupd bundle-add os-clr-on-clr \
20+
os-utils-gui-dev
21+
22+
* For CentOS
23+
24+
.. code-block:: console
25+
26+
sudo yum install gcc \
27+
libuuid-devel \
28+
openssl-devel \
29+
libpciaccess-devel
30+
31+
* For Fedora 27
32+
33+
.. code-block:: console
34+
35+
sudo dnf install gcc \
36+
libuuid-devel \
37+
openssl-devel \
38+
libpciaccess-devel
39+
40+
Build
41+
*****
42+
To build the Device Model
43+
44+
.. code-block:: console
45+
46+
make
47+
48+
To clean the build artefacts
49+
50+
.. code-block:: console
51+
52+
make clean
53+
54+
Runtime dependencies
55+
********************
56+
57+
* On CentOS
58+
59+
.. code-block:: console
60+
61+
sudo yum install openssl-libs \
62+
zlib \
63+
libpciaccess \
64+
libuuid
65+
66+
* On Fedora 27
67+
68+
.. code-block:: console
69+
70+
sudo dnf install openssl-libs \
71+
zlib \
72+
libpciaccess \
73+
libuuid
74+
75+
.. _`ACRN Hypervisor`: https://github.com/projectacrn/acrn-hypervisor
76+
.. _`Project ACRN documentation`: https://projectacrn.github.io/

0 commit comments

Comments
 (0)