+/*
+ * 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.
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.
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
the specific project, with the exception of clauses granting exclusive
rights.
+*/