Added expat reference to the README. Thanks marforic!
[fw/cortex-toolchain] / README
diff --git a/README b/README
index 640bdcc2e1cae479c9266763e67ffd1a56e40dab..9e3da55604f19024fe4612e37725b757c8263a69 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,41 @@
-To compile the arm toolchain for barebone arm devices:
-* Edit the shellscript header to match your environment
+REMEMBER!
+---------
+THE RESULTING TOOLCHAIN IS FOR BARE BONE ARM PROCESSOR SOFTWARE. NOT FOR USE
+WITH GLIBC OR THE LINUX KERNEL. DO NOT EVEN BOTHER TO ASK FOR THAT!
+
+To compile the ARM toolchain for barebone ARM devices:
+------------------------------------------------------
+* Edit the shell script to match your environment
 * Run it
 * Profit
 
-Currently tested and know to work target platforms:
-* STM32F10x (Olimex STM32-H103 eval board)
+Currently tested and known to work target platforms:
+----------------------------------------------------
+* STM32F10x (Olimex STM32-H103 eval board, Open-BLDC v0.1, v0.2, v0.3)
+
+Currently tested and known to work host platforms:
+--------------------------------------------------
+* Linux 32bit and 64bit (Debian unstable)
+* Mac OS X Snow Leopard with MacPorts
+
+Notes for Mac OS X users:
+-------------------------
+You need to install gmp, mpfr, mpc and libiconv packages using MacPorts,
+DarwinPorts or fink. GCC-4.5.1 requires them.
+
+For xml support in gdb you may want to install expat too. And add the 
+--with-expat parameter to GDB target.
+
+Notes for Linux users:
+----------------------
+You need to install several packages on debian just run:
+
+apt-get install flex bison libgmp3-dev libmpfr-dev libncurses5-dev \
+libmpc-dev autoconf texinfo build-essential
+
+You may want to try running the following comand instead too:
+
+apt-get build-dep gcc-4.5
 
-THE RESULTING TOOLCHAIN IS FOR BARE BONE ARM PROCESSOR SOFTWARE, NOT FOR USE
-WITH GLIBC OR THE LINUX KERNEL SO DO NOT EVEN BOTHER TO ASK FOR THAT!
+For xml support in gdb you may want to install libexpat1 and libexpat1-dev 
+too.