1/*! @file */
2
3/*! @mainpage Code Documentation
4
5@image html refos.png
6
7<h1>Abstract</h1>
8
9RefOS is a sample implementation of a simple multi-server operating system built on seL4.
10
11The aim of RefOS is to:
12<ul>
13    <li>Provide a reference design of a simple multi-server operating system built on seL4</li>
14    <li>Provide a sample implementation of how seL4 protocols can be used</li>
15    <li>Simplify development and porting of userland programs built on seL4</li>
16    <li>Serve as an example codebase to start new component-based seL4 projects</li>
17</ul>
18
19<h1>RefOS Features</h1>
20<ul>
21    <li>Simple and light-weight operating system</li>
22    <li>Multi-server component based design</li>
23    <li>Process and thread abstraction</li>
24    <li>Dataspace abstraction</li>
25    <li>Shared memory support</li>
26    <li>Dynamic mmap and sbrk support</li>
27    <li>Userland serial and timer drivers</li>
28    <li>Sample user programs include:
29        <ul>
30            <li>Terminal - a simple terminal program</li>
31            <li>Tetris - a port of Micro Tetris</li>
32            <li>Snake - a snake game</li>
33        </ul>
34    </li>
35</ul>
36
37Please note that RefOS is intended to be only an example system, a work-in-progress, and is not to be deployed as a real operating sytem solution. RefOS is not verified, is not high assurance, is not optimised for speed and efficiency and may be missing most of the features one would expect in a deployable operating system environment.
38
39<h1>Links</h1>
40See page \ref components for a description of the RefOS components.<br>
41See page \ref design for a RefOS design overview.<br>
42See page \ref testing for RefOS testing information.
43
44<p>
45<i>What does the logo mean? Pluto and Charon.</i>
46
47*/
48