README

   1
   2 REMEMBER!
   3 ---------
   4 THE RESULTING TOOLCHAIN IS FOR BARE BONE ARM PROCESSOR SOFTWARE. NOT FOR USE
   5 WITH GLIBC OR THE LINUX KERNEL. DO NOT EVEN BOTHER TO ASK FOR THAT!
   6
   7 To compile the ARM toolchain for barebone ARM devices:
   8 ------------------------------------------------------
   9 * Edit the shell script to match your environment
  10 * Run it
  11 * Profit
  12
  13 Currently tested and known to work target platforms:
  14 ----------------------------------------------------
  15 * STM32F10x (Olimex STM32-H103 eval board, Open-BLDC v0.1, v0.2, v0.3)
  16
  17 Currently tested and known to work host platforms:
  18 --------------------------------------------------
  19 * Linux 32bit and 64bit (Debian unstable)
  20 * Mac OS X Snow Leopard with MacPorts
  21
  22 Notes for Mac OS X users:
  23 -------------------------
  24 You need to install gmp, mpfr, mpc and libiconv packages using MacPorts,
  25 DarwinPorts or fink. GCC-4.5.1 requires them.
  26
  27 port install gmp mpfr libmpc
  28
  29 For xml support in gdb you may want to install expat too. And add the
  30 --with-expat parameter to GDB target.
  31
  32 Notes for Linux users:
  33 ----------------------
  34 You need to install several packages on debian just run:
  35
  36 apt-get install flex bison libgmp3-dev libmpfr-dev libncurses5-dev \
  37 libmpc-dev autoconf texinfo build-essential
  38
  39 You may want to try running the following comand instead too:
  40
  41 apt-get build-dep gcc-4.5
  42
  43 For xml support in gdb you may want to install libexpat1 and libexpat1-dev
  44 too.
  45
  46 How to submit improvements and patches
  47 --------------------------------------
  48 As more and more people start to submit patches and improvements to
  49 Summon-Arm-Toolchain (SAR) this section seems to become necessary.
  50
  51 First of all any way of submission is appreciated, if you just want to dump
  52 your version of the script to us feel free to do so. Still if you want your
  53 improvements and fixes to go upstream quicker there is a good way to do that.
  54
  55 1) Create an account on GitHub. (or some other git hosting service, if you
  56    really have to)
  57 2) Fork the main SAR repository.
  58 3) Clone the forked repository to your disk
  59 4) Change the script, try to make small changes adding one feature or bugfix at
  60    a time (That makes review much easier for us).
  61 5) Push your changes to GitHub, or the other service you chose
  62 6) Test your changes, by compiling the toolchain. (You probably want to do that
  63    with different options)
  64 7) Make sure that everything still works
  65 8) Test a little bit more
  66 9) Click on pull request on GitHub or drop us a line so that we can pull your
  67    changes
  68
  69 I know that sounds like a lot of work, but if you don't we have to do it and that means that your awesome improvement or bugfix will take longer to be integrated into the official script. And as you we want everyone to profit from such changes sooner then later. :)