Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Dziallas <sebastian@when.com>2010-05-22 14:47:47 (GMT)
committer Sebastian Dziallas <sebastian@when.com>2010-05-22 14:47:47 (GMT)
commit6b9fa036f5832b43ae2d6bb3b1994091668d95d7 (patch)
tree762bbc261087feac1fd0bc556023ff7840a0a3b7
parent72e1d6e652b1ca07e82ebe892acd8f7ef9b53721 (diff)
get content in shape for the upcoming v3 release
-rw-r--r--Creation Kit/en-US/Book_Info.xml2
-rw-r--r--Creation Kit/en-US/Chapter.xml471
-rw-r--r--Creation Kit/en-US/Revision_History.xml15
-rw-r--r--Creation Kit/en-US/images/soas-blueberry.pngbin148537 -> 0 bytes
-rw-r--r--Customization Guide/en-US/Book_Info.xml4
-rw-r--r--Customization Guide/en-US/Revision_History.xml14
-rw-r--r--Customization Guide/en-US/images/soas-blueberry.pngbin148537 -> 0 bytes
7 files changed, 263 insertions, 243 deletions
diff --git a/Creation Kit/en-US/Book_Info.xml b/Creation Kit/en-US/Book_Info.xml
index b433e61..73fa904 100644
--- a/Creation Kit/en-US/Book_Info.xml
+++ b/Creation Kit/en-US/Book_Info.xml
@@ -29,7 +29,7 @@ Sugar on a Stick.
<corpauthor>
<inlinemediaobject>
<imageobject>
- <imagedata fileref="images/soas-blueberry.png" format="PNG" />
+ <imagedata fileref="images/soas-mirabelle.png" format="PNG" />
</imageobject>
</inlinemediaobject>
</corpauthor>
diff --git a/Creation Kit/en-US/Chapter.xml b/Creation Kit/en-US/Chapter.xml
index 2333a20..0013a75 100644
--- a/Creation Kit/en-US/Chapter.xml
+++ b/Creation Kit/en-US/Chapter.xml
@@ -2,251 +2,242 @@
<!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>
+ <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>
+ <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 12 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 v3 Mirabelle</guimenuitem></menuchoice> in the drop-down menu on the upper-right side to download the liveUSB disk image. Alternatively, download Mirabelle <ulink url="http://download.sugarlabs.org/soas/releases/soas-3-mirabelle.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. Due to the numerous distributions out there, we cannot guarantee support for all of them, but are hoping to provide instructions for as many of them as possible and are looking forward to hearing your experiences with other distributions.
+ </para>
+ <section id="sect-Creation_Kit-Preparation-Linux_Instructions-Fedora">
+ <title>Fedora</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Execute this command as root:<command><replaceable>yum install liveusb-creator</replaceable></command>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Plug a blank target USB flash drive (or SD Card) into your computer (minimum 1-gigabyte) and follow <xref linkend="sect-Creation_Kit-Preparation-Windows_Instructions" />.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="sect-Creation_Kit-Preparation-Linux_Instructions-Other">
+ <title>Other Distributions</title>
+ <para>
+ For a graphical way of putting SoaS on a USB stick, we recommend using <application>UNetbootin</application>. Since version 393, it is able to create Fedora Live USB sticks, the technology Sugar on a Stick is using. Please feel free
+ </para>
+ <itemizedlist>
+ <listitem>
<para>
- These instructions are intended for use with Windows XP or higher.
+ Please check the <ulink url="http://unetbootin.sourceforge.net/">upstream website</ulink> for the latest version and use either the packages your distribution provides or the generic file.
</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>
+ </listitem>
+ <listitem>
<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.
+ Download the Sugar on a Stick image from <ulink url="http://download.sugarlabs.org/soas/releases/soas-3-mirabelle.iso">here</ulink>.
</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>
+ </listitem>
+ <listitem>
<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.
+ Open UNetbootin and plug a USB stick with a size of at least 1G in.
</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>
+ </listitem>
+ <listitem>
+ <para>
+ Click on <guibutton>Diskimage</guibutton> and select and open the .iso file you just downloaded for Sugar on a Stick above.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Select your USB device and click <guibutton>OK</guibutton> to proceed with the creation process. After a couple of minutes, your USB key should be ready.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ </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. This does, however, not guarantee that the resulting stick will work on a Mac, but possibly only on Linux or Windows machines. Hence, the Mac platform is not officially supported and instead marked as experimental.
+ </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-3-mirabelle.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-3-mirabelle.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>
diff --git a/Creation Kit/en-US/Revision_History.xml b/Creation Kit/en-US/Revision_History.xml
index e826633..bed1138 100644
--- a/Creation Kit/en-US/Revision_History.xml
+++ b/Creation Kit/en-US/Revision_History.xml
@@ -6,6 +6,21 @@
<simpara>
<revhistory>
<revision>
+ <revnumber>2</revnumber>
+ <date>Sat May 22 2010</date>
+ <author>
+ <firstname>Sebastian</firstname>
+ <surname>Dziallas</surname>
+ <email>sdz@sugarlabs.org</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Final commits before Mirabelle release</member>
+ <member>Update creation content for Linux and Mac</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
<revnumber>1</revnumber>
<date>Sun Feb 14 2010</date>
<author>
diff --git a/Creation Kit/en-US/images/soas-blueberry.png b/Creation Kit/en-US/images/soas-blueberry.png
deleted file mode 100644
index 1a0f21f..0000000
--- a/Creation Kit/en-US/images/soas-blueberry.png
+++ /dev/null
Binary files differ
diff --git a/Customization Guide/en-US/Book_Info.xml b/Customization Guide/en-US/Book_Info.xml
index c4b4778..76ddabc 100644
--- a/Customization Guide/en-US/Book_Info.xml
+++ b/Customization Guide/en-US/Book_Info.xml
@@ -6,7 +6,7 @@
<subtitle>A simple guide on how to customize SoaS</subtitle>
<productname>Sugar on a Stick</productname>
<productnumber>3</productnumber>
- <edition>1</edition>
+ <edition>2</edition>
<pubsnumber>0</pubsnumber>
<abstract>
<para>
@@ -28,7 +28,7 @@ and enables you to do more the open source way.
<corpauthor>
<inlinemediaobject>
<imageobject>
- <imagedata fileref="images/soas-blueberry.png" format="PNG" />
+ <imagedata fileref="images/soas-mirabelle.png" format="PNG" />
</imageobject>
</inlinemediaobject>
</corpauthor>
diff --git a/Customization Guide/en-US/Revision_History.xml b/Customization Guide/en-US/Revision_History.xml
index 2a97e68..b418eda 100644
--- a/Customization Guide/en-US/Revision_History.xml
+++ b/Customization Guide/en-US/Revision_History.xml
@@ -6,6 +6,20 @@
<simpara>
<revhistory>
<revision>
+ <revnumber>2</revnumber>
+ <date>Sat May 22 2010</date>
+ <author>
+ <firstname>Sebastian</firstname>
+ <surname>Dziallas</surname>
+ <email>sdz@sugarlabs.org</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Final commits before Mirabelle release</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
<revnumber>1</revnumber>
<date>Sun Mar 28 2010</date>
<author>
diff --git a/Customization Guide/en-US/images/soas-blueberry.png b/Customization Guide/en-US/images/soas-blueberry.png
deleted file mode 100644
index 1a0f21f..0000000
--- a/Customization Guide/en-US/images/soas-blueberry.png
+++ /dev/null
Binary files differ