X-Git-Url: https://codewiz.org/gitweb?p=bertos.git;a=blobdiff_plain;f=README;h=50256eea5d552b5681ba640cb26a66a318cf57c3;hp=11e207bf4aace502c7453d59eb6d98b2dcb7d312;hb=57dfb183e24175bc782647d4e6aebe31063f3881;hpb=9250b166f2d62d6e38bca6cea5c6210266a12128

diff --git a/README b/README
old mode 100755
new mode 100644
index 11e207bf..50256eea
--- a/README
+++ b/README
@@ -1,70 +1,16 @@
-/*
- * 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 structure Directory Structure
-
-The modules are sorted in subdirectories by their category:
-
- - kern/ - Simple multitasking kernel implementation;
- - drv/ - Hardware drivers;
- - mware/ - Algorithms, containers and other standalone code;
- - io/ - Infrastructure of I/O-related modules for hosted applications;
- - os/ - OS-abstraction layers for hosted environments;
-
-The top-level directory contains a few support headers that are meant
-to be usable by any C or C++, embedded or hosted application.  The
-top-level directory also contains a few example templates for files
-that are meant to be customized on a per-application basis.  These
-files are hw.h, config.h, verstag.h and arch_config.h.
-
-To achieve the highest possible reusability, most DevLib components
-are designed for fine-grained modularity and minimal external
-dependencies.  Most non-essential features can be configured out for
-applications with small memory footprint requirements.
-
-
-\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!