diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-15 11:01:58 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-15 11:01:58 +0000 |
| commit | 48b3c9976c76258e99166023db241ca4261f679f (patch) | |
| tree | 4df1893527c21c9ef28e45c45835f53588a5b534 /README.txt | |
| parent | b61049f7222a6290e2164966bd90f636bcb577f9 (diff) | |
| download | lufa-48b3c9976c76258e99166023db241ca4261f679f.tar.gz lufa-48b3c9976c76258e99166023db241ca4261f679f.tar.bz2 lufa-48b3c9976c76258e99166023db241ca4261f679f.zip | |
Use sub pages in main library documentation to improve readability.
Diffstat (limited to 'README.txt')
| -rw-r--r-- | README.txt | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/README.txt b/README.txt new file mode 100644 index 000000000..36c68a43a --- /dev/null +++ b/README.txt @@ -0,0 +1,22 @@ +
+ _ _ _ ___ _
+ | | | | | __/ \
+ | |_| U | _| o | - The Lightweight USB
+ |___|___|_||_n_| Framework for AVRs
+ =========================================
+ Written by Dean Camera
+ http://www.fourwalledcubicle.com
+ =========================================
+
+
+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. From there, the
+generated HTML documentation for the library itself will be avaliable in the
+LUFA/Documentation/html/ directory. View this documentation in your chosen web
+browser for further Getting Started information.
+
+The documentation for the library itself (but not the documentation for the
+individual demos, projects or bootloaders) is also available as a seperate
+package from the project webpage for convenience if Doxygen cannot be installed.
\ No newline at end of file |