aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/StudioIntegration/VSIX/GettingStarted.htm
blob: 28d7c068a31a289f1a6352014109236c58715e3f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
	<head>
		<title>Getting Started with LUFA</title>

		<meta http-equiv="content-type" content="text/html; charset=utf-8"/>

		<style media="screen" type="text/css">
			/* Reset */
			html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p,
			blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, font,
			img, ins, kbd, q, s, samp, small, strike, strong, sub, tt, var, b, u, i,
			center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption,
			tbody, tfoot, thead, tr, th, td { margin: 0; padding: 0; border: 0; outline: 0;
			font-size: 100%; vertical-align: baseline; background: transparent; } body {
			line-height: 1; } ol, ul { list-style: none; } blockquote, q { quotes: none; }
			blockquote:before, blockquote:after, q:before, q:after { content: ''; content:
			none; } :focus { outline: 0; } ins { text-decoration: none; } del { text-decoration: line-through; }
			table { border-collapse: collapse; border-spacing: 0; }

			body
			{
				background-color: #353535;
			}

			#container
			{
				width: 800px;
				margin-top: 20px;
				margin-left: auto;
				margin-right: auto;
				border: 1px solid #DDC;
			}

			#header
			{
				background-color: #3D3229;
				text-align: center;
				font: bold 2.5em "Times New Roman", serif;
				color: #CCB;
				padding: 20px;
			}

			#header span
			{
				color: #998
			}

			#footer
			{
				text-align: center;
				font: normal 1em "Georgia", sans-serif;
				color: #CCB;
				padding: 20px;
			}

			#content
			{
				background-color: #EAE0D6;
				padding: 20px;
			}

			#content p
			{
				line-height: 1.4em;
				padding: 0.2em 0 1.2em;
				font: normal 1em "Georgia", sans-serif;
			}

			#content tt
			{
				font: normal 1em "Consolas", sans-serif;
			}

			#content h1
			{
				font: bold 1.3em "Georgia", sans-serif;
				color: #3D3229;
				margin-top: 2em;
				margin-bottom: 0.2em;
			}

			#content a
			{
				color: #3D3229;
			}

			#content img
			{
				display: block;
				margin-left: auto;
				margin-right: auto;
				margin-top: .5em;
				margin-bottom: 1em;
			}

			#installedinfo
			{
				text-align: center;
				font: italic 1.1em "Georgia", sans-serif !important;
			}
		</style>
	</head>
	<body>
		<div id="container">
			<div id="header">
				<h1>Thanks for installing <span>LUFA</span></h1>
			</div>

			<div id="content">
				<p id="installedinfo">The LUFA extension is now installed into Atmel Studio, and
				   is ready for use.
				</p>

				<h1>Create an Example Project</h1>
				<p>LUFA comes with a variety of example projects, showing off several of the library features. Also included is a number of
				   bootloaders, full LUFA powered projects, and several user-contributed projects. To see these, open the <em>New Example Project</em>
				   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
				   of LUFA projects.
				</p>

				   <img width="700px" src="NewExampleWizard.png" alt="Atmel Studio New Example Wizard" />

				<h1>Configure LUFA</h1>
				<p>The LUFA Atmel Studio extension is fully integrated into the Atmel Studio IDE, including the LUFA sub-modules. Open the
					<em>ASF Wizard</em> from the <tt>ASF&rarr;ASF Wizard</tt> menu, choose your project from your current solution, then choose
					the LUFA library as the extension to configure from the <em>Available Modules</em> portion of the wizard. Here you can
					add and remove LUFA modules to and from your project as you need them.
				</p>

				   <img width="700px" src="ASFWizard.png" alt="Atmel ASF Module Wizard" />

				<h1>Find the Module APIs</h1>
				<p>You can view your project's included LUFA modules any time you need to from the <em>ASF Explorer</em> window, accessible from
					the <tt>ASF&rarr;ASF Explorer</tt> menu. Here you can find a link to the module's corresponding API documentation in the LUFA
					manual, as well as a direct link to the module's API header.
				</p>

				   <img src="ASFExplorer.png" alt="Atmel ASF Explorer Tool Window" />

				<h1>Get Help</h1>
				<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
				   jump directly to the relevant documentation for a function, variable, type or other LUFA symbol in your code by first selecting
				   it and pressing the <tt>F1</tt> key. If the integrated Help package fails to instal, you can re-try from the
				   <tt>Help&rarr;LUFA Help&rarr;Reinstall LUFA Help</tt> menu entry.
				</p>

				   <img width="700px" src="LUFAHelpMenu.png" alt="Atmel ASF Module Wizard" />

				<p>The latest LUFA manual is also available for viewing <a href="http://www.lufa-lib.org/documentation">online</a>, if you
				   do not wish to use the integrated help.
				</p>
				<p>
					If you are still stuck and need help, please post on the <a href="http://www.lufa-lib.org/support">LUFA Mailing List</a>
					- or just search the mailing list archives to see if your question has already been answered.
				</p>

				<h1>Read About the Latest Developments</h1>
				<p>Keep up to date with the latest LUFA news; read the <a href="http://www.fourwalledcubicle.com/blog">author's blog</a>,
				   or see the <a href="http://www.fourwalledcubicle.com/">author's website</a>.
				</p>
			</div>
		</div>
		<div id="footer"><p>LUFA - <em>the Lightweight USB Framework for AVRs</em></p></div>
	</body>
</html>