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

[bertos.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..68b5489
--- /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!