Commit dea897ef authored by Dean Camera's avatar Dean Camera
Browse files

Make main readme file easier to read, and make documentation build instructions clearer.

parent 35b79469
......@@ -272,8 +272,8 @@
* should be called in response to the host state machine entering the \ref HOST_STATE_Addressed state. This function
* will return an error code from the class driver's <i><b>{Class Name}</b>_EnumerationFailure_ErrorCodes_t</i> enum
* to indicate if the driver sucessfully initialized the instance and bound it to an interface in the attached device.
* Like all the class driver functions, this function takes in the address of the specific instance you wish to initialize
* - in this manner, multiple seperate instances of the same class type can be initialized. A fragment of a Class Driver
* Like all the class driver functions, this function takes in the address of the specific instance you wish to initialize -
* in this manner, multiple seperate instances of the same class type can be initialized. A fragment of a Class Driver
* based Host mode application may look like the following:
*
* \code
......
......@@ -14,7 +14,8 @@
* allows for the free use of the LUFA library, bootloaders and (where the sole copyright
* is attributed to Dean Camera) demos without public disclosure within an organization, in
* addition to three free hours of consultation with the library author, and priority support.
* Please contact the author for more information via the address shown on on \ref Page_Resources.
* Please visit the Commercial License link on \ref Page_Resources for more information on
* ordering a commercial license for your company.
*
* \verbinclude License.txt
*/
_ _ _ ___ _
| | | | | __/ \
| |_| U | _| o | - The Lightweight USB
|___|___|_||_n_| Framework for AVRs
=========================================
Written by Dean Camera
dean [at] fourwalledcubicle [dot] com
http://www.fourwalledcubicle.com/LUFA.php
=========================================
LUFA is donation supported. To support LUFA,
please donate at http://www.fourwalledcubicle.com.
For Commercial Licensing information, see
http://fourwalledcubicle.com/PurchaseLUFA.php
This package contains the complete LUFA library, demos, user-submitted projects
and bootloaders for use with compatible microcontroller models. To get started,
you will need to install the "Doxygen" documentation generation tool from
www.doxygen.org, and run "make doxygen" from the command line whilst inside the
extracted LUFA download package directory. From there, the generated Doxygen
HTML documentation for the library and included projects will be available in the
generated Documentation/ subdirectories of the library core and projects. View
the generated documentation for the library core in your chosen web browser for
further Getting Started information.
_ _ _ ___ _
| | | | | __/ \
| |_| U | _| o | - The Lightweight USB
|___|___|_||_n_| Framework for AVRs
=========================================
Written by Dean Camera
dean [at] fourwalledcubicle [dot] com
http://www.fourwalledcubicle.com/LUFA.php
=========================================
LUFA is donation supported. To support LUFA,
please donate at http://www.fourwalledcubicle.com.
For Commercial Licensing information, see
http://fourwalledcubicle.com/PurchaseLUFA.php
This package contains the complete LUFA library, demos, user-submitted
projects and bootloaders for use with compatible microcontroller models.
LUFA is a simple to use, lightweight framework which sits atop the hardware
USB controller in specific AVR microcontroller models, and allows for the
quick and easy creation of complex USB devices and hosts.
To get started, you will need to install the "Doxygen" documentation
generation tool. If you use Linux, this can be installed via the "doxygen"
package in your chosen package management tool - under Ubuntu, this can be
acheived by running the following command in the terminal:
sudo apt-get install doxygen
Other package managers and distributions will have similar methods to
install Doxygen. In Windows, you can download a prebuilt installer for
Doxygen from its website, www.doxygen.org.
Once installed, you can then use the Doxygen tool to generate the library
documentation from the command line or terminal of your operating system. To
do this, open your terminal or command line to the root directory of the
LUFA package, and type the following command:
make doxygen
Which will recursively generate documentation for all elements in the
library - the core, plus all demos, projects and bootloaders. Generated
documentation will then be available by opening the file "index.html" of the
created Documentation/html/ subdirectories inside each project folder.
The documentation for the library itself (but not the documentation for the
individual demos, projects or bootloaders) is also available as a separate
package from the project webpage for convenience if Doxygen cannot be installed.
\ No newline at end of file
package from the project webpage for convenience if Doxygen cannot be
installed.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment