X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=README.bertos;h=7986d20fc3ec0003ae20bf235219f2c2099b6c07;hb=5e75e84ec8e806f7ded1207b395be2fb09a60a35;hp=7cd5c553c7eed0e29607480c5a4d8bb079761ee9;hpb=33c9ca58467c0a834c0752570506893c71ed3fb8;p=bertos.git

diff --git a/README.bertos b/README.bertos
index 7cd5c553..7986d20f 100644
--- 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
 
@@ -35,8 +41,8 @@ memory footprint requirements.
 \section features Features
 
   - multitasking kernel with IPC, semaphores, priority levels;
-  - a comprehensive set of generic drivers for a wide range of devices, 
-    which can be easily customized to the actual hardware: timer, serial, 
+  - a comprehensive set of generic drivers for a wide range of devices,
+    which can be easily customized to the actual hardware: timer, serial,
     adc, ntc, pwm, stepper motors, dc motors, lcd, keyboards, buzzer, eeprom;
   - full graphic subsystem for simple displays, with font support, bitmaps,
     clipping, text formatting, interactive menus;
@@ -53,26 +59,29 @@ memory footprint requirements.
 
 The modules are sorted in subdirectories by their category:
 
-  - algo/    : algorithms;
-  - app/     : demo application;
-  - cfg/     : configuration stuff;
-  - doc/     : documentation;
-  - drv/     : hardware drivers;
-  - dt/	     : experimental object oriented gui toolkit;
-  - emul/    : Qt-based emulator framework for embedded applications;
-  - fonts/   : fonts;
-  - fs/      : file system related stuff;
-  - gfx/     : general purpose graphics routines;
-  - gui/     : widgets for simple displays;
-  - hw/	     : hardware-specific declarations;
-  - icons/   : conversion tool from image TXT format to LCD bitmap;
-  - kern/    : multitasking kernel;
-  - mware/   : algorithms, containers and other standalone code;
-  - os/	     : OS-abstraction layers for hosted environments;
+  - app/            : demo applications;
+  - bertos/algo/    : algorithms;
+  - bertos/cfg/     : configuration stuff;
+  - bertos/drv/     : hardware drivers;
+  - bertos/dt/	    : experimental object oriented gui toolkit;
+  - bertos/emul/    : Qt-based emulator framework for embedded applications;
+  - bertos/fonts/   : fonts;
+  - bertos/fs/      : file system related stuff;
+  - bertos/gfx/     : general purpose graphics routines;
+  - bertos/gui/     : widgets for simple displays;
+  - bertos/hw/	    : hardware-specific declarations;
+  - bertos/icons/   : conversion tool from image TXT format to LCD bitmap;
+  - bertos/kern/    : multitasking kernel;
+  - 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