LUFA/StudioIntegration/VSIX/GettingStarted.htm

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3         <head>
   4                 <title>Getting Started with LUFA</title>
   5
   6                 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
   7
   8                 <style media="screen" type="text/css">
   9                         /* Reset */
  10                         html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p,
  11                         blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, font,
  12                         img, ins, kbd, q, s, samp, small, strike, strong, sub, tt, var, b, u, i,
  13                         center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption,
  14                         tbody, tfoot, thead, tr, th, td { margin: 0; padding: 0; border: 0; outline: 0;
  15                         font-size: 100%; vertical-align: baseline; background: transparent; } body {
  16                         line-height: 1; } ol, ul { list-style: none; } blockquote, q { quotes: none; }
  17                         blockquote:before, blockquote:after, q:before, q:after { content: ''; content:
  18                         none; } :focus { outline: 0; } ins { text-decoration: none; } del { text-decoration: line-through; }
  19                         table { border-collapse: collapse; border-spacing: 0; }
  20
  21                         body
  22                         {
  23                                 background-color: #353535;
  24                         }
  25
  26                         #container
  27                         {
  28                                 width: 800px;
  29                                 margin-top: 20px;
  30                                 margin-left: auto;
  31                                 margin-right: auto;
  32                                 border: 1px solid #DDC;
  33                         }
  34
  35                         #header
  36                         {
  37                                 background-color: #3D3229;
  38                                 text-align: center;
  39                                 font: bold 2.5em "Times New Roman", serif;
  40                                 color: #CCB;
  41                                 padding: 20px;
  42                         }
  43
  44                         #header span
  45                         {
  46                                 color: #998
  47                         }
  48
  49                         #footer
  50                         {
  51                                 text-align: center;
  52                                 font: normal 1em "Georgia", sans-serif;
  53                                 color: #CCB;
  54                                 padding: 20px;
  55                         }
  56
  57                         #content
  58                         {
  59                                 background-color: #EAE0D6;
  60                                 padding: 20px;
  61                         }
  62
  63                         #content p
  64                         {
  65                                 line-height: 1.4em;
  66                                 padding: 0.2em 0 1.2em;
  67                                 font: normal 1em "Georgia", sans-serif;
  68                         }
  69
  70                         #content tt
  71                         {
  72                                 font: normal 1em "Consolas", sans-serif;
  73                         }
  74
  75                         #content h1
  76                         {
  77                                 font: bold 1.3em "Georgia", sans-serif;
  78                                 color: #3D3229;
  79                                 margin-top: 2em;
  80                                 margin-bottom: 0.2em;
  81                         }
  82
  83                         #content a
  84                         {
  85                                 color: #3D3229;
  86                         }
  87
  88                         #content img
  89                         {
  90                                 display: block;
  91                                 margin-left: auto;
  92                                 margin-right: auto;
  93                                 margin-top: .5em;
  94                                 margin-bottom: 1em;
  95                         }
  96
  97                         #installedinfo
  98                         {
  99                                 text-align: center;
 100                                 font: italic 1.1em "Georgia", sans-serif !important;
 101                         }
 102                 </style>
 103         </head>
 104         <body>
 105                 <div id="container">
 106                         <div id="header">
 107                                 <h1>Thanks for installing <span>LUFA</span></h1>
 108                         </div>
 109
 110                         <div id="content">
 111                                 <p id="installedinfo">The LUFA extension is now installed into Atmel Studio, and
 112                                    is ready for use.
 113                                 </p>
 114
 115                                 <h1>Create an Example Project</h1>
 116                                 <p>LUFA comes with a variety of example projects, showing off several of the library features. Also included is a number of
 117                                    bootloaders, full LUFA powered projects, and several user-contributed projects. To see these, open the <em>New Example Project</em>
 118                                    wizard from the <tt>File&rarr;New</tt> menu. Expand out the <em>FourWalledCubicle</em> node, then the <em>Dean Camera - LUFA</em> node to see a list
 119                                    of LUFA projects.
 120                                 </p>
 121
 122                                    <img width="700px" src="NewExampleWizard.png" alt="Atmel Studio New Example Wizard" />
 123
 124                                 <h1>Configure LUFA</h1>
 125                                 <p>The LUFA Atmel Studio extension is fully integrated into the Atmel Studio IDE, including the LUFA sub-modules. Open the
 126                                         <em>ASF Wizard</em> from the <tt>ASF&rarr;ASF Wizard</tt> menu, choose your project from your current solution, then choose
 127                                         the LUFA library as the extension to configure from the <em>Available Modules</em> portion of the wizard. Here you can
 128                                         add and remove LUFA modules to and from your project as you need them.
 129                                 </p>
 130
 131                                    <img width="700px" src="ASFWizard.png" alt="Atmel ASF Module Wizard" />
 132
 133                                 <h1>Find the Module APIs</h1>
 134                                 <p>You can view your project's included LUFA modules any time you need to from the <em>ASF Explorer</em> window, accessible from
 135                                         the <tt>ASF&rarr;ASF Explorer</tt> menu. Here you can find a link to the module's corresponding API documentation in the LUFA
 136                                         manual, as well as a direct link to the module's API header.
 137                                 </p>
 138
 139                                    <img src="ASFExplorer.png" alt="Atmel ASF Explorer Tool Window" />
 140
 141                                 <h1>Get Help</h1>
 142                                 <p>If you installed the integrated help package, you can view the LUFA manual from the <tt>Help&rarr;View Help</tt> menu, or just
 143                                    jump directly to the relevant documentation for a function, variable, type or other LUFA symbol in your code by first selecting
 144                                    it and pressing the <tt>F1</tt> key. If the integrated Help package fails to install, you can re-try from the
 145                                    <tt>Help&rarr;LUFA Help&rarr;Reinstall Local Help</tt> menu entry.
 146                                 </p>
 147
 148                                    <img width="700px" src="LUFAHelpMenu.png" alt="Atmel ASF Module Wizard" />
 149
 150                                 <p>The latest LUFA manual is also available for viewing <a href="http://www.lufa-lib.org/documentation">online</a>, if you
 151                                    do not wish to use the integrated help.
 152                                 </p>
 153                                 <p>
 154                                         If you are still stuck and need help, please post on the <a href="http://www.lufa-lib.org/support">LUFA Mailing List</a>
 155                                         - or just search the mailing list archives to see if your question has already been answered.
 156                                 </p>
 157
 158                                 <h1>Read About the Latest Developments</h1>
 159                                 <p>Keep up to date with the latest LUFA news; read the <a href="http://www.fourwalledcubicle.com/blog">author's blog</a>,
 160                                    or see the <a href="http://www.fourwalledcubicle.com/">author's website</a>.
 161                                 </p>
 162                         </div>
 163                 </div>
 164                 <div id="footer"><p>LUFA - <em>the Lightweight USB Framework for AVRs</em></p></div>
 165         </body>
 166 </html>