tmk_core/protocol/lufa/LUFA-git/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_CompilingApps_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_CompilingApps_PreqWindows Windows Prerequisites
  17  *  On Windows, you will need a copy of the latest Atmel Toolchain (<a>http://www.atmel.com/tools/ATMELAVRTOOLCHAINFORWINDOWS.aspx</a>),
  18  *  either downloaded and installed as a standalone package, or installed as part of Atmel Studio. You will need to ensure
  19  *  that the "bin" directory of the toolchain 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  *  \subsection SSec_CompilingApps_PreqLinux Linux Prerequisites
  27  *  On Linux systems you will need to install the latest Linux distribution of the standalone Atmel Toolchain from the
  28  *  Atmel website (<a>http://www.atmel.com/tools/ATMELAVRTOOLCHAINFORLINUX.aspx</a>), or use the latest avr-libc and avr-gcc packages
  29  *  for your chosen distribution's package manager. For full device support, the Atmel standalone Toolchain package is recommended.
  30  *
  31  *  \section Sec_CompilingApps_Compiling Compiling a LUFA Application
  32  *  Compiling the LUFA demos, applications and/or bootloaders is very simple. LUFA comes with makefile scripts for
  33  *  each individual demo, bootloader and project folder, as well as scripts in the Demos/, Bootloaders/, Projects/
  34  *  and the LUFA root directory. Compilation of projects can be started from any of the above directories, with a build
  35  *  started from an upper directory in the directory structure executing build of all child directories under it. This
  36  *  means that while a build inside a particular demo directory will build only that particular demo, a build started from
  37  *  the /Demos/ directory will build all LUFA demo projects sequentially.
  38  *
  39  *  To build a project from the source via the command line, the command <b>"make all"</b> should be executed from the command
  40  *  line in the directory of interest. To remove compiled files (including the binary output, all intermediately files and all
  41  *  diagnostic output files), execute <b>"make clean"</b>. Once a "make all" has been run and no errors were encountered, the
  42  *  resulting binary will be located in the generated ".HEX" file. If your project makes use of pre-initialized EEPROM
  43  *  variables, the generated ".EEP" file will contain the project's EEPROM data.
  44  *
  45  *  \see \ref Page_BuildSystem for information on the LUFA build system.
  46  */