X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=README;fp=README;h=25a848b795a1de1c417b7167cc805393afd54b01;hb=ca0dfb083920cf47cd5ca91bda4e31eeb09f68dd;hp=6ce5bf36c46c4ef77785f57e574df02deb95af19;hpb=b329fe228f081ec0d011874dfb3774e515648053;p=bertos.git diff --git a/README b/README index 6ce5bf36..25a848b7 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,8 +20,7 @@ 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 is no consistent scope or design guide-line for the components of DevLib, altough there is a common coding and documentation style. @@ -29,8 +34,7 @@ dependant on others to avoid code duplication, but most of the times you can configure out features you don't need. -Redistribution -============== +\section redist Redistribution DevLib is a collection of independent works originally written by several different contributors. Unless otherwise noted, all material @@ -41,3 +45,4 @@ by Develer, said parts are subject to the same licensing terms covering the specific project, with the exception of clauses granting exclusive rights. +*/