-/*
- * This document is automatically processed by Doxygen (http://www.doxygen.org/).
- * Don't remove special formatting tags.
- */
-/*!
+This is the source code of BeRTOS operating system.
-\mainpage
+You can generate the documentation using doxygen with the file Doxyfile-offline:
+$ doxygen Doxyfile-offline
+You can read the generated documentation by opening the file
+doc/offline-reference/html/index.html
-\section overview Overview
+You can read the latest documentation online at the following address:
+http://dev.bertos.org/doxygen
-DevLib is a collection of small reusable components designed by Develer
-for internal use in many embedded and portable applications.
+Tutorials can be found here:
+http://www.bertos.org/use/tutorial-front-page
-These source files are intended to be shared between very different
-environments, from 8bit processors to Linux and Win32 hosted
-applications, using a wide range of compilers.
+The support forum is located at forum.bertos.org.
-DevLib is not strictly a library or a portability layer. It's also
-definitely not an OS, altough some of its components can be combined
-together to form a multitasking kernel with some IPC functionality.
-
-
-\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.
-Every piece of code that looks useful for more than one application
-may end up here, regardless of compatibility and fitness with other
-modules.
-
-Most of DevLib is written in C, but some services intended for higher
-level, OS-hosted applications are written in C++. Some modules are
-dependant on others to avoid code duplication, but most of the times
-you can configure out features you don't need.
-
-
-\section redist Redistribution
-
-DevLib is a collection of independent works originally written by
-several different contributors. Unless otherwise noted, all material
-is provided under the terms of the GPL (see LICENSE.GPL).
-
-Alternatively, when parts of DevLib are included in projects developed
-by Develer, said parts are subject to the same licensing terms covering
-the specific project, with the exception of clauses granting exclusive
-rights.
-
-*/
+Have fun with BeRTOS!
projects / bertos.git / blobdiff