1.. _acrn_home:
2
3Project ACRN Documentation
4##########################
5
6Welcome to the Project ACRN (version |version|) documentation published |today|.
7ACRN is a flexible, lightweight reference hypervisor, built with real-time and
8safety-criticality in mind, optimized to streamline embedded development through
9an open source platform.
10
11.. comment The links in this grid display can't use :ref: because we're
12   using raw html.  There's a risk of broken links if referenced content is
13   moved.
14
15.. raw:: html
16
17   <ul class="grid">
18       <li class="grid-item">
19           <a href="introduction/index.html">
20               <img alt="" src="_static/images/ACRNlogo80w.png"/>
21               <h2>What is ACRN</h2>
22           </a>
23           <p>Overview, architecture,
24              features, and use-case scenarios</p>
25       </li>
26       <li class="grid-item">
27           <a href="try.html">
28               <span class="grid-icon fa fa-map-signs"></span>
29               <h2>Getting Started</h2>
30           </a>
31           <p>Getting started guides for quickly running scenario-based
32              samples</p>
33       </li>
34       <li class="grid-item">
35           <a href="develop.html">
36               <span class="grid-icon fa fa-cogs"></span>
37               <h2>Advanced Guides</h2>
38           </a>
39           <p>Tools, tutorials, features, and debugging guides that go beyond getting started</p>
40       </li>
41       <li class="grid-item">
42           <a href="contribute.html">
43               <span class="grid-icon fa fa-github"></span>
44               <h2>Developer Reference</h2>
45           </a>
46           <p>High-level design and details, developer and
47              contribution guidelines, API details</p>
48       </li>
49       <li class="grid-item">
50           <a href="release_notes/index.html">
51               <span class="grid-icon fa fa-sign-in"></span>
52               <h2>Release<br/>Notes</h2>
53           </a>
54           <p>Archived Release Notes</p>
55       </li>
56       <li class="grid-item">
57           <a href="reference/hardware.html">
58               <span class="grid-icon fa fa-object-group"></span>
59               <h2>Supported<br/>Hardware</h2>
60           </a>
61           <p>Supported hardware platforms and boards</p>
62       </li>
63   </ul>
64
65
66Source code for Project ACRN is maintained in the
67`Project ACRN GitHub repo`_, and is provided under the BSD 3-clause
68license.
69
70.. toctree::
71   :maxdepth: 1
72   :hidden:
73
74   Documentation Home <self>
75   introduction/index
76   try
77   develop
78   contribute
79   release_notes/index
80   asa
81   projects/index
82   glossary
83   genindex
84
85.. _Project ACRN GitHub repo: https://github.com/projectacrn
86