From: lottaviano <lottaviano@38d2e660-2303-0410-9eaa-f027e97ec537>
Date: Tue, 4 Jan 2011 22:00:27 +0000 (+0000)
Subject: doc: Add README file, sorely missing from source code distribution
X-Git-Tag: 2.7.0~302
X-Git-Url: https://codewiz.org/gitweb?a=commitdiff_plain;h=67e29ae6cb560d36a32d19008d9394a2d4194b5e;p=bertos.git

doc: Add README file, sorely missing from source code distribution

git-svn-id: https://src.develer.com/svnoss/bertos/trunk@4664 38d2e660-2303-0410-9eaa-f027e97ec537
---

diff --git a/README b/README
new file mode 100644
index 00000000..68b5489c
--- /dev/null
+++ b/README
@@ -0,0 +1,14 @@
+This is the source code of BeRTOS operating system.
+
+You can generate the documentation using doxygen with the file Doxyfile-offline:
+$ doxygen Doxyfile-offline
+
+You can read the latest documentation online at the following address:
+http://dev.bertos.org/doxygen
+
+Tutorials can be found here:
+http://www.bertos.org/use/tutorial-front-page
+
+The support forum is located at forum.bertos.org.
+
+Have fun with BeRTOS!