X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=README.bertos;h=5abaa06dce362e39fb971cc637280fc446018878;hb=943539779aa9509626c0c7a825c600d9a949839f;hp=2ef126a198ee52cb3a93c1c96f56f3d5f4ef8096;hpb=c77272832164f775a03295724aa0ec052960a863;p=bertos.git diff --git a/README.bertos b/README.bertos index 2ef126a1..5abaa06d 100644 --- a/README.bertos +++ b/README.bertos @@ -1,9 +1,16 @@ -/* - * This document is automatically processed by Doxygen (http://www.doxygen.org/). - * Don't remove special formatting tags. - */ /*! +\if DEVELOPER_NOTE_ON + +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. +\endif + + + \mainpage \section overview Overview @@ -66,13 +73,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