]> git.gir.st - tmk_keyboard.git/blob - protocol/lufa/LUFA-120730/LUFA/DoxygenPages/CompilingApps.txt
Squashed 'tmk_core/' content from commit 05caacc
[tmk_keyboard.git] / protocol / lufa / LUFA-120730 / LUFA / DoxygenPages / CompilingApps.txt
1 /** \file
2 *
3 * This file contains special DoxyGen information for the generation of the main page and other special
4 * documentation pages. It is not a project source file.
5 */
6
7 /** \page Page_CompilingApps Compiling the Demos, Bootloaders and Projects
8 *
9 * The following details how to compile the included LUFA demos, applications and bootloaders using AVR-GCC.
10 *
11 * \section Sec_Prerequisites Prerequisites
12 * Before you can compile any of the LUFA library code or demos, you will need a recent distribution of avr-libc (1.6.2+)
13 * and the AVR-GCC (4.2+) compiler. A standard "coreutils" package for your system is also required for command line
14 * compilation of LUFA based applications.
15 *
16 * \subsection SSec_PreqWindows Windows Prerequisites
17 * On Windows, you will need a copy of the latest Atmel Toolchain, either downloaded and installed as a standalone
18 * package, or installed as part of Atmel Studio. You will need to ensure that the "bin" directory of the toolchain
19 * is available in your system's <b>PATH</b> environment variable.
20 *
21 * In addition, you will need to install a ported version of the ZSH or BASH *nix shells, and a standard set of *nix
22 * utilities such as <i>cut</i>, <i>find</i> and <i>sed</i>. These can be found in the "basic" system package of the
23 * of the MinGW installer (<a>http://www.mingw.org</a>). Once installed, add the "msys\1.0\bin" of the MinGW installation
24 * folder is added to your system's <b>PATH</b> environment variable.
25 *
26 * The bootloaders currently also require the "bc" application, which can be installed from
27 * <a>http://gnuwin32.sourceforge.net/downlinks/bc.php</a>. Once installed add the "GnuWin32\bin" path of the GnuWin32
28 * installation folder to your system's <b>PATH</b> environment variable.
29 *
30 * \subsection SSec_PreqLinux Linux Prerequisites
31 * On Linux systems you will need to install the latest Linux distribution of the standalone Atmel Toolchain from the
32 * Atmel website for general development, or use the latest avr-libc and avr-gcc packages for your chosen distribution's
33 * package manager. For full device support, the Atmel standalone package is recommended.
34 *
35 * \section Sec_Compiling Compiling a LUFA Application
36 * Compiling the LUFA demos, applications and/or bootloaders is very simple. LUFA comes with makefile scripts for
37 * each individual demo, bootloader and project folder, as well as scripts in the Demos/, Bootloaders/, Projects/
38 * and the LUFA root directory. Compilation of projects can be started from any of the above directories, with a build
39 * started from an upper directory in the directory structure executing build of all child directories under it. This
40 * means that while a build inside a particular demo directory will build only that particular demo, a build started from
41 * the /Demos/ directory will build all LUFA demo projects sequentially.
42 *
43 * To build a project from the source via the command line, the command <b>"make all"</b> should be executed from the command
44 * line in the directory of interest. To remove compiled files (including the binary output, all intermediately files and all
45 * diagnostic output files), execute <b>"make clean"</b>. Once a "make all" has been run and no errors were encountered, the
46 * resulting binary will be located in the generated ".HEX" file. If your project makes use of pre-initialized EEPROM
47 * variables, the generated ".EEP" file will contain the project's EEPROM data.
48 *
49 * \see \ref Page_BuildSystem for information on the LUFA build system.
50 */
Imprint / Impressum