X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=README.bertos;h=65edccce173bdbd65b734aafc134564f61c7e98c;hb=74a5c3ac788026f092548e6acf3dab4cc3783a9b;hp=2ef126a198ee52cb3a93c1c96f56f3d5f4ef8096;hpb=c77272832164f775a03295724aa0ec052960a863;p=bertos.git diff --git a/README.bertos b/README.bertos index 2ef126a1..65edccce 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 @@ -17,10 +21,11 @@ environments, from 8-bit processor to Linux and Win32 hosted application \section history History and Motivation -BeRTOS was born as a collection of useful, highly optimized and fine-tuned -libraries for embedded systems. Each library had its own scope and could be -used singularly in a project, though they were also meant to cooperate to -build the whole underlying software layer commonly called "operating system". +BeRTOS was born as a extremely modular, highly optimized and fine-tuned +operating system for embedded programming. +As a result, each module has its own scope and can be used alone or in +cooperation with other modules. +It's even possible to use most of the drivers without activating the kernel module. We have grown it following our guidelines: simplicity and beauty. These guidelines made it possible to evolve it in a full-featured real @@ -29,7 +34,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 +71,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