From c142399273babe2cb6c47ad714494fde77a22893 Mon Sep 17 00:00:00 2001
From: Giovanni Di Sirio <gdisirio@gmail.com>
Date: Thu, 3 May 2018 12:52:11 +0000
Subject: Added builder for full RM manual including RT, NIL, HAL and EX in a
 single document. Separated documents will be phased out later.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11991 110e8d01-0319-4d1e-a829-52ad28d1bb01
---
 doc/full_rm/src/main.dox | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 doc/full_rm/src/main.dox

(limited to 'doc/full_rm/src/main.dox')

diff --git a/doc/full_rm/src/main.dox b/doc/full_rm/src/main.dox
new file mode 100644
index 000000000..7da6fadad
--- /dev/null
+++ b/doc/full_rm/src/main.dox
@@ -0,0 +1,48 @@
+/*
+    ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio.
+
+    This file is part of ChibiOS.
+
+    ChibiOS is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 3 of the License, or
+    (at your option) any later version.
+
+    ChibiOS is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @mainpage Introduction
+ * @author Giovanni Di Sirio (gdisirio@users.sourceforge.net).
+ *
+ * <h2>Chibi ?</h2>
+ * I didn't want a serious name for this project. It is the Japanese word for
+ * small as in small child. So ChibiOS
+ * @htmlonly (<span class="t_nihongo_kanji" xml:lang="ja" lang="ja">&#12385;&#12403;</span>OS) @endhtmlonly
+ * means small Operating System.
+ * Source <a href="http://en.wikipedia.org/wiki/Chibi" target="_blank">Wikipedia</a>.
+ *
+ * <h2>Features</h2>
+ * ChibiOS is composed by several subsystems that are part of the project or
+ * external software components.
+ *
+ * <h3>Subsystems</h3>
+ * - RT, a full features RTOS.
+ * - NIL, another RTOS with a very reduced footprint.
+ * - OSLIB, a library of RTOS enhancements, it can be used on top of both RT
+ *   NIL.
+ * - HAL, an abstraction layer for common MCU peripherals.
+ * - EX, abstraction for board-level devices, it sits on top of HAL.
+ * .
+ * <h3>External Components</h3>
+ * - FatFS.
+ * - lwIP.
+ * - WolfSSL.
+ * .
+ */
-- 
cgit v1.2.3