X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=README.bertos;h=8300de76d376d1ef24980dd9ef415bc334712ee4;hb=e4a9947b5436beaeb91eacd98cdb762aa040b04f;hp=2ef126a198ee52cb3a93c1c96f56f3d5f4ef8096;hpb=c77272832164f775a03295724aa0ec052960a863;p=bertos.git diff --git a/README.bertos b/README.bertos index 2ef126a1..8300de76 100644 --- 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. - */ /*! + + \mainpage @@ -29,7 +33,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 @@ -66,13 +70,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