Restore previous BeRTOS demo.

[bertos.git] / README.bertos

diff --git a/README.bertos b/README.bertos
index 68e18a86dc975e7d6eef4b46c78a3275b7e2dde4..fc6e8f181c5c096a141ee4d09d294e47f7f56ead 100644 (file)
--- a/README.bertos
+++ b/README.bertos
@@ -1,6 +1,12 @@
-BeRTOS                                                         -*- outline -*-
+/*
+ * This document is automatically processed by Doxygen (http://www.doxygen.org/).
+ * Don't remove special formatting tags.
+ */
+/*!
 
-* Overview
+\mainpage
+
+\section overview Overview
 
 BeRTOS is a real-time operating system designed for building applications
 for embedded systems, like reference boards, test boards, or custom boards.
@@ -9,7 +15,7 @@ It has a modular structure: its components can be used in very different
 environments, from 8-bit processor to Linux and Win32 hosted application
 (for debug purpose), using a wide range of compilers.
 
-* History and Motivation
+\section history History and Motivation
 
 BeRTOS was born as a collection of useful, highly optimized and fine-tuned
 libraries for embedded systems.  Each library had its own scope and could be
@@ -26,7 +32,7 @@ designed for fine-grained modularity and minimal external dependencies.
 Most non-essential features can be configured out for application with small
 memory footprint requirements.
 
-* Features
+\section features Features
 
   - multitasking kernel with IPC, semaphores, priority levels;
   - a comprehensive set of generic drivers for a wide range of devices, 
@@ -43,7 +49,7 @@ memory footprint requirements.
   - XMODEM protocol implementation;
   - RLE compression algorithm;
 
-* Directory Structure
+\section structure Directory Structure
 
 The modules are sorted in subdirectories by their category:
 
@@ -68,3 +74,23 @@ The modules are sorted in subdirectories by their category:
 
 The top-level directory contains a few support headers that are meant to be
 usable by any C/C++ embedded or hosted application.
+
+\section license License
+
+BeRTOS is provided under the term of the GNU General Public License
+(see LICENSE.GPL) with following exception:
+
+\verbatim
+
+As a special exception, you may use this file as part of a free software
+library without restriction.  Specifically, if other files instantiate
+templates or use macros or inline functions from this file, or you compile
+this file and link it with other files to produce an executable, this
+file does not by itself cause the resulting executable to be covered by
+the GNU General Public License.  This exception does not however
+invalidate any other reasons why the executable file might be covered by
+the GNU General Public License.
+
+\endverbatim
+
+*/