X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=README;h=50256eea5d552b5681ba640cb26a66a318cf57c3;hb=5f4ad7298d1d8d411286e18ba23b201b57e653b2;hp=a299b2bd31fdc77a06c6b5002b1c3e5a75970d47;hpb=96f0ef786b54356c56cc3d4e4f0838df2505cfcc;p=bertos.git diff --git a/README b/README old mode 100755 new mode 100644 index a299b2bd..50256eea --- a/README +++ b/README @@ -1,43 +1,16 @@ +This is the source code of BeRTOS operating system. -Overview -======== +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 -DevLib is a collection of small reusable components designed by Develer -for internal use in many embedded and portable applications. +You can read the latest documentation online at the following address: +http://dev.bertos.org/doxygen -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. +Tutorials can be found here: +http://www.bertos.org/use/tutorial-front-page -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. - - -Scope (or lack thereof) -======================= - -There's no consistent scope or design guide-line for the components -of DevLib (altough there's 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. - - -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. +The support forum is located at forum.bertos.org. +Have fun with BeRTOS!