Split Getting Started page of the documentation into its own section.

[pub/lufa.git] / LUFA / ManPages / ProgrammingApps.txt

diff --git a/LUFA/ManPages/ProgrammingApps.txt b/LUFA/ManPages/ProgrammingApps.txt
new file mode 100644 (file)
index 0000000..1e3be71
--- /dev/null
+++ b/LUFA/ManPages/ProgrammingApps.txt
@@ -0,0 +1,27 @@
+/** \file\r
+ *\r
+ *  This file contains special DoxyGen information for the generation of the main page and other special\r
+ *  documentation pages. It is not a project source file.\r
+ */\r
+ \r
+/** \page Page_ProgrammingApps Programming an Application into a USB AVR\r
+ *\r
+ *  Once you have built an application, you will need a way to program in the resulting ".HEX" file (and, if your\r
+ *  application uses EEPROM variables with initial values, also a ".EEP" file) into your USB AVR. Normally, the\r
+ *  reprogramming an AVR device must be performed using a special piece of programming hardware, through one of the\r
+ *  supported AVR programming protocols - ISP, HVSP, HVPP, JTAG or dW. This can be done through a custom programmer,\r
+ *  a third party programmer, or an official Atmel AVR tool - for more information, see the Atmel.com website.\r
+ *\r
+ *  Alternatively, you can use the bootloader. From the Atmel factory, each USB AVR comes preloaded with the Atmel\r
+ *  DFU (Device Firmware Update) class bootloader, a small piece of AVR firmware which allows the remainder of the\r
+ *  AVR to be programmed through a non-standard interface such as the serial USART port, SPI, or (in this case) USB.\r
+ *  Bootloaders have the advantage of not requiring any special hardware for programming, and cannot usually be erased\r
+ *  or broken without an external programming device. They have disadvantages however; they cannot change the fuses of\r
+ *  the AVR (special configuration settings that control the operation of the chip itself) and a small portion of the\r
+ *  AVR's FLASH program memory must be reserved to contain the bootloader firmware, and thus cannot be used by the\r
+ *  loaded application. Atmel's DFU bootloader is either 4KB (for the smaller USB AVRs) or 8KB (for the larger USB AVRs).\r
+ *\r
+ *  If you wish to use the DFU bootloader to program in your application, refer to your DFU programmer's documentation.\r
+ *  Atmel provides a free utility called FLIP which is USB AVR compatible, and an open source (Linux compatible)\r
+ *  alternative exists called "dfu-programmer".\r
+ */
\ No newline at end of file