aboutsummaryrefslogtreecommitdiffstats
path: root/readme.txt
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2007-09-18 12:24:10 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2007-09-18 12:24:10 +0000
commit33e14433c4b9007b72e166775576484e6263c48b (patch)
tree5b265602b10c3fe69ef46e810698a950e1177a38 /readme.txt
parent7fc3e18c7cf4948c0ea8f814da376415206ec999 (diff)
downloadChibiOS-33e14433c4b9007b72e166775576484e6263c48b.tar.gz
ChibiOS-33e14433c4b9007b72e166775576484e6263c48b.tar.bz2
ChibiOS-33e14433c4b9007b72e166775576484e6263c48b.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@4 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'readme.txt')
-rw-r--r--readme.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/readme.txt b/readme.txt
new file mode 100644
index 000000000..016a661ae
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,25 @@
+Directories structure:
+
+./readme.txt - This file.
+./license.txt - GPL3 license file.
+./src/ - ChibiOS/RT portable kernel source files.
+./src/include/ - ChibiOS/RT include files.
+./src/templates/ - ChibiOS/RT non portable source templates, new ports are
+ started by copying the templates into a new directory
+ under ./demos/.
+./ports/ - Architecture/compiler specific portable files.
+./demos/ - Demo programs for specific archtectures/boards.
+./docs/doxifile - Doxigen project file.
+./docs/index.html - ChibiOS/RT documentation (after running doxigen).
+
+Current ports under ./demos:
+
+Win32-MinGW - ChibiOS/RT simulator and demo into a WIN32 process,
+ MinGW version.
+Win32-MSVS - ChibiOS/RT simulator and demo into a WIN32 process,
+ Visual Studio 7 or any later version should work.
+LPC214x-GCC - ChibiOS/RT port for ARM7 LPC2148, the demo targets the
+ Olimex LPC-P2148 board. This port can be easily modified
+ for any processor into the LPC2000 family or other
+ boards. The demo can be compiled using YAGARTO or any
+ other GCC-based ARM toolchain.