doc: Add user documentation for proc module.

[bertos.git] / README.bertos

diff --git a/README.bertos b/README.bertos
index 2ef126a198ee52cb3a93c1c96f56f3d5f4ef8096..7986d20fc3ec0003ae20bf235219f2c2099b6c07 100644 (file)
--- a/README.bertos
+++ b/README.bertos
@@ -1,8 +1,14 @@
-/*
- * 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
 
@@ -66,13 +72,16 @@ The modules are sorted in subdirectories by their category:
   - bertos/hw/     : hardware-specific declarations;
   - bertos/icons/   : conversion tool from image TXT format to LCD bitmap;
   - bertos/kern/    : multitasking kernel;
-  - bertos/mware/   : algorithms, containers and other standalone code;
+  - bertos/mware/   : algorithms, other standalone code;
+  - bertos/struct/  : containers and other data structures;
   - bertos/os/     : OS-abstraction layers for hosted environments;
   - doc/            : documentation;
 
 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