doc: Specify error codes returned by kblock_error().

[bertos.git] / doc / README.bertos

diff --git a/doc/README.bertos b/doc/README.bertos
index 65edccce173bdbd65b734aafc134564f61c7e98c..d8123093519a316a4d7a28061dcf4a6366f85f2f 100644 (file)
--- a/doc/README.bertos
+++ b/doc/README.bertos
@@ -1,3 +1,60 @@
+/**
+\page short_introduction A 5 minute introduction to BeRTOS
+
+\section installation Installing BeRTOS on your system
+
+What do you need when developing an embedded project with BeRTOS?
+\li a toolchain for your CPU
+\li BeRTOS source code :)
+\li supporting binaries for BeRTOS build system
+\li supporting tools for BeRTOS Wizard
+
+See the <a href="">installation instructions page</a> online for help
+on installing BeRTOS on your system.
+
+Strictly speaking, BeRTOS doesn't need to be 'installed', you can just
+take .c files and compile them in your project.
+
+However, BeRTOS is a complex system with many dependencies between modules.
+It's not easy to track the dependencies for each module, so we have developed
+a set of tools to make dependency tracking automatic.
+
+Contact the <a href="http://forum.bertos.org">support forum</a> if you want
+help on using BeRTOS without the supporting tools. Be warned, though, that
+this method is not supported and we can only point you in the right direction.
+
+\section organization Project's organization
+
+Each project has its own full BeRTOS sources, configuration and HAL files.
+Why? Because we think that each project has its own life and it must not
+interfere with any other project.
+Let's say you use a shared BeRTOS version for all of your projects. Each
+time you update, you need to check that each and every project still works
+correctly. We don't want to do this (and I bet you don't want either).
+However, it's still easy to update a single project if you want to.
+
+A project named Foo is organized as follows:
+\li bertos/ - BeRTOS source directory
+\li Makefile - BeRTOS build system Makefile
+\li project.bertos - Wizard's configuration file
+\li foo/ - your project's main directory
+\li foo/hw/ - low level HAL files
+\li foo/cfg/ - configuration directory
+\li foo/foo_user.mk - makefile fragment that you can edit
+\li foo/foo.mk - makefile fragment changed by the Wizard, don't edit
+
+See <a href="">BeRTOS HAL system</a> for more information on HAL files.
+
+\section coding Coding guidelines
+
+Don't change configuration settings by hand, use the Wizard. This is because
+sometimes there are more actions to be done than simply changing a value.
+
+Include configuration files using "..." rather than <...> style, otherwise you
+will use default configuration values instead of your project's values.
+
+*/
+
 /*!
 <!--
 This document is automatically processed by Doxygen (http://www.doxygen.org/).