doc: Add xmodem documentation.

[bertos.git] / README.bertos

diff --git a/README.bertos b/README.bertos
index 7c7cfb122126f275737767c7cadcfa92ac188b79..65edccce173bdbd65b734aafc134564f61c7e98c 100644 (file)
--- a/README.bertos
+++ b/README.bertos
@@ -1,8 +1,12 @@
-/*
- * This document is automatically processed by Doxygen (http://www.doxygen.org/).
- * Don't remove special formatting tags.
- */
 /*!
+<!--
+This document is automatically processed by Doxygen (http://www.doxygen.org/).
+Don't remove special formatting tags.
+This section won't be processed unless enabled.
+
+See STATUS for further information and tips about Doxygen tags.
+-->
+
 
 \mainpage
 
@@ -17,10 +21,11 @@ environments, from 8-bit processor to Linux and Win32 hosted application
 
 \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
-used singularly in a project, though they were also meant to cooperate to
-build the whole underlying software layer commonly called "operating system".
+BeRTOS was born as a extremely modular, highly optimized and fine-tuned
+operating system for embedded programming.
+As a result, each module has its own scope and can be used alone or in
+cooperation with other modules.
+It's even possible to use most of the drivers without activating the kernel module.
 
 We have grown it following our guidelines: simplicity and beauty.
 These guidelines made it possible to evolve it in a full-featured real
@@ -29,7 +34,7 @@ without giving up reliability and performace.
 
 To achieve the highest possible reusability, most BeRTOS components are
 designed for fine-grained modularity and minimal external dependencies.
-Most non-essential features can be configured out for application with small
+Most non-essential features can be configured out for applications with small
 memory footprint requirements.
 
 \section features Features
@@ -74,6 +79,8 @@ 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.
 
+See the \ref dev_status page for information about the various drivers.
+
 \section license License
 
 BeRTOS is provided under the term of the GNU General Public License