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. For Windows users, the best way to obtain these is the WinAVR project
  14  *  (<a>http://winavr.sourceforge.net</a>) as this provides a single-file setup for everything required to compile your
  15  *  own AVR projects.
  16  *
  17  *  \section Sec_Compiling Compiling a LUFA Application
  18  *  Compiling the LUFA demos, applications and/or bootloaders is very simple. LUFA comes with makefile scripts for
  19  *  each individual demo, bootloader and project folder, as well as scripts in the /Demos/, /Bootloaders/, /Projects/
  20  *  and the LUFA root directory. This means that compilation can be started from any of the above directories, with
  21  *  a build started from an upper directory in the directory structure executing build of all child directories under it.
  22  *  This means that while a build inside a particular demo directory will build only that particular demo, a build stated
  23  *  from the /Demos/ directory will build all LUFA demo projects sequentially.
  24  *
  25  *  To build a project from the source via the command line, the command <b>"make all"</b> should be executed from the command line in the directory
  26  *  of interest. To remove compiled files (including the binary output, all intermediately files and all diagnostic output
  27  *  files), execute <b>"make clean"</b>. Once a "make all" has been run and no errors were encountered, the resulting binary will
  28  *  be located in the generated ".HEX" file. If your project makes use of pre-initialized EEPROM variables, the generated ".EEP"
  29  *  file will contain the project's EEPROM data.
  30  */