Merge pull request #128 from logxen/edge
[clinton/Smoothieware.git] / gcc4mbed / README.creole
1 ==Current Version
2 **GCC Version:** [[https://launchpad.net/gcc-arm-embedded/4.6/4.6-2012-q1-update|GCC ARM Embedded 4.6-2012-q1-update]]\\
3 **mbed SDK Version:** [[http://mbed.org/handbook/mbed-Library-Releases|Revision 43]]\\
4
5 ==Previous Versions
6 [[https://github.com/adamgreen/gcc4mbed/tree/cs2011.03-42_mbed28|Code Sourcery G++ Lite 2011.03-42 with mbed SDK revision 28]]\\
7
8 ==Quick Start
9 These are the quick steps to get gcc4mbed installed on your computer:
10 * Download the gcc4mbed compressed archive from [[https://github.com/adamgreen/gcc4mbed/zipball/master]]
11 * Decompress and extract the contents of this archive.
12 * Run the install script appropriate for your platform:
13 ** Windows: win_install.cmd
14 ** OS X: mac_install
15 ** Linux: linux_install
16 * You can then run the BuildShell script which will be created during the install to properly configure the PATH environment variable. You may want to edit this script to further customize your development environment.
17
18 ===Important Notes:
19 * Files will fail to install to a FAT based file system. Extract to a more appropriate file system (ie. NTFS on Windows) first and then copy to a FAT drive after installation.
20 * If the installation should fail, please refer to win_install.log, linux_install.log, or mac_install.log. It will contain the details of the installation process and any errors that were encountered.
21 * The OS X install only supports 64-bit Intel machines. The installers for the other platforms only install 32-bit Intel binaries.
22
23 ==More Information
24 **[[https://github.com/adamgreen/mri/blob/master/README.creole#mri---monitor-for-remote-inspection|Debugging]]:** Learn how to use the GNU Debugger, GDB, with the new MRI debug monitor in GCC4MBED.\\
25 \\
26 **[[https://github.com/adamgreen/gcc4mbed/blob/master/notes/overview.creole#overview|Overview]]:** Overview and a bit of history related to this GCC4MBED project.\\
27 \\
28 **[[https://github.com/adamgreen/gcc4mbed/blob/master/notes/install.creole#installation|Installation]]:** For more information about how to install and use the GCC4MBED project.\\
29 \\
30 **[[https://github.com/adamgreen/gcc4mbed/blob/master/notes/makefile.creole#make-variables|Makefile Configuration]]:** Information about makefile options to customize your project's binary.\\
31 \\
32 **[[https://github.com/adamgreen/gcc4mbed/blob/master/notes/porting.creole#readme|Porting]]:** Notes on porting applications from mbed cloud compiler to offline GCC4MBED project.\\
33
34 ==Thanks
35 The author wants to thank Arthur Wolf for the [[http://mbed.org/forum/mbed/topic/2336/|posting]] he made back in May which kicked off this whole gcc4mbed project and for all of the testing and feedback he has given since.
36
37 Thanks to Felyza Wishbringer for writing the first Windows install script which provided the inspiration for the Windows, Mac, and Linux scripts that are now included in the gcc4mbed project.
38
39 Thanks for all of the others who have provided valuable feedback since this project was first released. Much of that feedback can be found in this [[http://mbed.org/forum/mbed/topic/2701/|mbed forum thread]]
40
41 ==Have fun!!