Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/Creation Kit/en-US/Chapter.xml
blob: 2333a2093f1840f6c12317235ca0c3ee29575295 (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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
]>
<chapter id="chap-Creation_Kit-Preparation">
	<title>Preparation</title>
	<para>
		This chapter will demonstrate the stages required to prepare Sugar on a Stick on different platforms and guide you through them step by step. Please pay close attention to the instructions to make sure no loss of data occurs.
	</para>

	<section id="sect-Creation_Kit-Preparation-System_Requirements">
		<title>System Requirements</title>
	<table id="tabl-Creation_Kit-Preparation-System_Requirements-Platforms">
		<title>Platforms</title>
			<tgroup cols="3">
				<colspec colname="Platform" colnum="1" colwidth="2*"></colspec>
				<colspec colname="Requirements" colnum="2" colwidth="4*"></colspec>
				<colspec colname="Notes" colnum="3" colwidth="4*"></colspec>
				<thead>
					<row>
						<entry> Platform </entry>
						<entry> Requirements </entry>
						<entry> Notes </entry>
					</row>
				</thead>
				<tbody>
					<row>
						<entry> <simplelist> <member>  Windows </member> </simplelist> </entry>
						<entry>
							<simplelist>
								<member> Windows XP or higher </member>
								<member> at least 2 GB of free hard disk space </member>
							</simplelist>
						</entry>
						<entry> <simplelist> <member> older versions may be unsupported </member> </simplelist> </entry>
					</row>
					<row>
						<entry> <simplelist> <member> Linux </member> </simplelist> </entry>
						<entry>
							<simplelist>
								<member> Fedora 11 or higher </member>
								<member> Ubuntu 8.04 or higher </member>
								<member> at least 2 GB of free hard disk space </member>
							</simplelist>
						</entry>
						<entry>
							<simplelist>
								<member> older versions may be unsupported </member>
								<member> other distributions may be unsupported </member>
								<member> the syslinux isomd5sum cryptsetup packages </member>
							</simplelist>
						</entry>
					</row>
					<row>
						<entry> <simplelist> <member>  Mac </member> </simplelist> </entry>
						<entry>
							<simplelist>
								<member> Mac OS X 10.6 or higher </member>
								<member> at least 2 GB of free hard disk space </member>
							</simplelist>
						</entry>
						<entry>
							<simplelist>
								<member> older versions may be unsupported </member>
								<member> a python 2.6 installation is required </member>
							</simplelist>
						</entry>
					</row>
				</tbody>
			</tgroup>
	</table>
	</section>
	<section id="sect-Creation_Kit-Preparation-Windows_Instructions">
		<title>Windows Instructions</title>
		<mediaobject>
		<imageobject>
			<imagedata fileref="images/liveusb-creator-win.png" format="PNG" width="240" />
		</imageobject>
		<textobject><phrase>Fedora LiveUSB Creator on Windows</phrase></textobject>
		</mediaobject>
		<para>
			These instructions are intended for use with Windows XP or higher.
		</para>
		<itemizedlist>
			<listitem>
				<para>
					Download the latest <application>Fedora LiveUSB Creator</application> from <ulink url="https://fedorahosted.org/liveusb-creator/">https://fedorahosted.org/liveusb-creator/</ulink> and install it.
				</para>
			</listitem>
			<listitem>
				<para>
					Plug a blank target USB flash drive (or SD Card) into your computer (minimum 1-gigabyte).
				</para>
			</listitem>
			<listitem>
				<para>
					Launch LiveUSB Creator.
				</para>
			</listitem>
			<listitem>
				<para>
					Select <menuchoice><guimenuitem>Sugar on a Stick v2 Blueberry</guimenuitem></menuchoice> in the drop-down menu on the upper-right side to download the liveUSB disk image. Alternatively, download Blueberry <ulink url="http://download.sugarlabs.org/soas/releases/soas-2-blueberry.iso">here</ulink>, then hit the Browse button and select the downloaded file.
				</para>
			</listitem>
			<listitem>
				<para>
					Set the Persistent Storage slider to the maximum. This enables you to save the child's work in Sugar onto the device.
				</para>
				<blockquote>
					<important>
						<title>Important</title>
						<para>
							If you repeat this installation on a device after having saved some Sugar work or changes, all Sugar work and changes will be lost.
						</para>
					</important>
					<para>
						You may allocate as much storage as there is capacity on your device. You may allocate less than the maximum, if you want to use some of the device storage when not booting Sugar. 
					</para>
				</blockquote>
			</listitem>
			<listitem>
				<para>
					Select your flash drive as the target and click the <guibutton>Create Live USB</guibutton> button.
				</para>
			</listitem>
			<listitem>
				<para>
					Wait for the process to finish, then close the LiveUSB Creator program.
				</para>
			</listitem>
			<listitem>
				<para>
					Stop your flash drive using the <guilabel>Safely Remove Hardware</guilabel> dialog and eject it.
				</para>
			</listitem>
		</itemizedlist>
	</section>
	
	<section id="sect-Creation_Kit-Preparation-Linux_Instructions">
		<title>Linux Instructions</title>
		<para>
			These instructions are intended for use with current Linux distributions. Supported examples include recent versions of Fedora, as well as of Ubuntu. Other distributions might work or require slight adjustments in the process.
		</para>
		<itemizedlist>
			<listitem>
				<para>
					Download the Sugar on a Stick image from <ulink url="http://download.sugarlabs.org/soas/releases/soas-2-blueberry.iso">here</ulink>.
				</para>
			</listitem>
			<listitem>
				<para>
					Install these three packages: <command><replaceable>syslinux</replaceable></command>, <command><replaceable>isomd5sum</replaceable></command>, and <command><replaceable>cryptsetup</replaceable></command>
				</para>
			</listitem>
			<listitem>
				<para>
					Plug a blank target USB flash drive (or SD Card) into your computer (minimum 1-gigabyte).
				</para>
			</listitem>
			<listitem>
				<para>
					Download the installation script: <ulink url="http://download.sugarlabs.org/soas/releases/livecd-iso-to-disk.sh">http://download.sugarlabs.org/soas/releases/livecd-iso-to-disk.sh</ulink>
				</para>
			</listitem>
			<listitem>
				<para>
					Change mode to make the script executable: <command>chmod +x livecd-iso-to-disk.sh</command>
				</para>
			</listitem>
			<listitem>
				<para>
					Unmount the USB flash drive (e.g. <command>sudo umount /dev/sdb1</command>)
				</para>
			</listitem>
			<listitem>
				<para>
					Execute the script with the following command: <command>sudo ./livecd-iso-to-disk.sh --overlay-size-mb 300 soas-2-blueberry.iso /dev/sdb1</command>
				</para>
				<blockquote>
					<important>
						<title>Important</title>
						<para>
							To prevent unnecessary data loss, it is important to understand the different elements of the command line you are executing.
						</para>
					</important>
					<para>
						In this case, we have assumed the USB device node to be sdb. It is essential that you verify this before continuing. If your USB key contains no partitions, you might also need to drop the number at the end of the USB device node definition.
					</para>
					<para>
						Additionally, you can also increase or decrease the overlay size for storing your data. Keep in mind that executing the command twice will remove the old overlay, and thus your stored files.
					</para>
					<note>
						<title>Note</title>
						<para>
							You might also want to add the <command>--efi</command> or <command>--xo</command> parameters, depending on later use. The former one is a requirement for booting the stick on a limited number of Macs, the latter one for booting it on OLPC's XO-1.
						</para>
					</note>
				</blockquote>
			</listitem>
		</itemizedlist>
	</section>
	<section id="sect-Creation_Kit-Preparation-Mac_Instructions">
		<title>Mac Instructions</title>
		<mediaobject>
		<imageobject>
			<imagedata fileref="images/image-writer-mac.png" format="PNG" width="240" />
		</imageobject>
		<textobject><phrase>Image Writer on Mac</phrase></textobject>
		</mediaobject>
		<para>
			These instructions are intended for use with Mac OS X. Whereas it is possible to prepare Sugar on a Stick on a Mac, the stick will with some certainty only work on normal machines. A definite requirement is the use of a Mac with Intel processor.
		</para>
		<note>
			<title>Note</title>
			<para>
				This way of preparing Sugar on a Stick does not create a persistant overlay. This means that you will not be able to keep the data you created in Sugar after reboot.
			</para>
		</note>
		<itemizedlist>
			<listitem>
				<para>
					Download the Sugar on a Stick image from <ulink url="http://download.sugarlabs.org/soas/releases/soas-2-blueberry.iso">here</ulink>.
				</para>
			</listitem>
			<listitem>
				<para>
					Download the image-writer tool for Macs from <ulink url="http://download.sugarlabs.org/soas/releases/image-writer-mac">here</ulink>.
				</para>
			</listitem>
			<listitem>
				<para>
					Plug a blank target USB flash drive (or SD Card) into your computer (minimum 1-gigabyte).
				</para>
			</listitem>
			<listitem>
				<para>
					Execute the following command in Terminal: <command>cd Downloads; python image-writer-mac soas-2-blueberry.iso</command>
				</para>
				<warning>
					<title>Warning</title>
					<para>
						If you proceed here, your flash drive will be wiped and you will lose all data on it.
					</para>
				</warning>
			</listitem>
			<listitem>
				<para>
					The script will output a device name; confirm that it matches with your flash drive.
				</para>
			</listitem>
		</itemizedlist>
	</section>
</chapter>