X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=README;h=11e207bf4aace502c7453d59eb6d98b2dcb7d312;hb=96f8c49fdf97d48ddbacb1d8d94fd5a735051e2d;hp=a299b2bd31fdc77a06c6b5002b1c3e5a75970d47;hpb=96f0ef786b54356c56cc3d4e4f0838df2505cfcc;p=bertos.git

diff --git a/README b/README
index a299b2bd..11e207bf 100755
--- a/README
+++ b/README
@@ -1,6 +1,12 @@
+/*
+ * This document is automatically processed by Doxygen (http://www.doxygen.org/).
+ * Don't remove special formatting tags.
+ */
+/*!
 
-Overview
-========
+\mainpage
+
+\section overview Overview
 
 DevLib is a collection of small reusable components designed by Develer
 for internal use in many embedded and portable applications.
@@ -14,11 +20,10 @@ definitely not an OS, altough some of its components can be combined
 together to form a multitasking kernel with some IPC functionality.
 
 
-Scope (or lack thereof)
-=======================
+\section scope Scope (or lack thereof)
 
-There's no consistent scope or design guide-line for the components
-of DevLib (altough there's a common coding and documentation style).
+There is no consistent scope or design guide-line for the components
+of DevLib, altough there is a common coding and documentation style.
 Every piece of code that looks useful for more than one application
 may end up here, regardless of compatibility and fitness with other
 modules.
@@ -29,8 +34,29 @@ dependant on others to avoid code duplication, but most of the times
 you can configure out features you don't need.
 
 
-Redistribution
-==============
+\section structure Directory Structure
+
+The modules are sorted in subdirectories by their category:
+
+ - kern/ - Simple multitasking kernel implementation;
+ - drv/ - Hardware drivers;
+ - mware/ - Algorithms, containers and other standalone code;
+ - io/ - Infrastructure of I/O-related modules for hosted applications;
+ - os/ - OS-abstraction layers for hosted environments;
+
+The top-level directory contains a few support headers that are meant
+to be usable by any C or C++, embedded or hosted application.  The
+top-level directory also contains a few example templates for files
+that are meant to be customized on a per-application basis.  These
+files are hw.h, config.h, verstag.h and arch_config.h.
+
+To achieve the highest possible reusability, most DevLib components
+are designed for fine-grained modularity and minimal external
+dependencies.  Most non-essential features can be configured out for
+applications with small memory footprint requirements.
+
+
+\section redist Redistribution
 
 DevLib is a collection of independent works originally written by
 several different contributors.  Unless otherwise noted, all material
@@ -41,3 +67,4 @@ by Develer, said parts are subject to the same licensing terms covering
 the specific project, with the exception of clauses granting exclusive
 rights.
 
+*/