Difference between revisions of "Balsa Prototype"

From LSDevLinux
Jump to: navigation, search
m (Remove unsightly gap)
(Restructure and reorder)
Line 6: Line 6:
 
# Based on Xubuntu ''Jaunty'', created using an automated builder process.
 
# Based on Xubuntu ''Jaunty'', created using an automated builder process.
  
== BALSA User Environment ==
+
=== Prototype 1 (Intrepid) ===
  
The BALSA user environment uses the lxlauncher with a tabbed taskbar. There are six tabs:
+
This is available by downloading a tarball from the main [http://balsa.kkoncepts.net/ BALSA site]. This tarball is installed onto a newly-formatted SD card. It can be done on the XO itself by putting the tarball onto a USB flash drive and following the instructions.
 +
 
 +
The tarball was produced by a manual process which involved installing Xubuntu to a real system, adding users and installing packages, and then saving the result.
 +
 
 +
This prototype is described on the main site, so isn't described any further here.
 +
 
 +
=== Prototype 2 (Jaunty) ===
 +
 
 +
This prototype can also use the tarball distribution mechanism. However, due to the use of an automated builder that is driven by a description called a "buildfile", it is open to customization through editing of the buildfile before running the builder process.
 +
 
 +
The rest of this page refers to Prototype 2.
 +
 
 +
== The BALSA User Environment ==
 +
 
 +
The BALSA user environment uses the launcher-based UI with a tabbed taskbar. There are six tabs:
  
 
# Work ([[:Image:Balsa_User_Work_screen.png|screenshot]])
 
# Work ([[:Image:Balsa_User_Work_screen.png|screenshot]])
Line 17: Line 31:
 
# Settings ([[:Image:Balsa_User_Settings_Screenshot.png|screenshot]])
 
# Settings ([[:Image:Balsa_User_Settings_Screenshot.png|screenshot]])
  
== Prototype 1 (Intrepid) ==
+
== Running the Builder ==
 
 
This is available by downloading a tarball from the main [http://balsa.kkoncepts.net/ BALSA site]. This tarball is installed onto a newly-formatted SD card. It can be done on the XO itself by putting the tarball onto a USB flash drive and following the instructions.
 
 
 
The tarball was produced by a manual process which involved installing Xubuntu to a real system, adding users and installing packages, and then saving the result.
 
 
 
== Prototype 2 (Jaunty) ==
 
 
 
This prototype can also use the tarball distribution mechanism. However, due to the use of an automated builder that is driven by a description called a "buildfile", it is open to customization through editing of the buildfile before running the builder process.
 
 
 
=== Running the builder ===
 
  
 
''Notes:''
 
''Notes:''
Line 34: Line 38:
 
# This process is meant to be undertaken by a maintainer or distributor of BALSA '''only'''. It is not intended to be performed by language advisers or on-site technicians. They should simply download the finished image for installation to an SD card. (To do this, they can use the same process described on the main BALSA site, using the ''latest.tbz2'' file that is created by the builder).
 
# This process is meant to be undertaken by a maintainer or distributor of BALSA '''only'''. It is not intended to be performed by language advisers or on-site technicians. They should simply download the finished image for installation to an SD card. (To do this, they can use the same process described on the main BALSA site, using the ''latest.tbz2'' file that is created by the builder).
 
# The builder itself is about 25MB, and will download another 150MB as it runs. This is in addition to downloading the Xubuntu CD, which is about 650MB. The total download size is slightly larger than for downloading a built image, so using the builder is useful only if you want to customize the process, or keep up with improvements to the builder as they are released.
 
# The builder itself is about 25MB, and will download another 150MB as it runs. This is in addition to downloading the Xubuntu CD, which is about 650MB. The total download size is slightly larger than for downloading a built image, so using the builder is useful only if you want to customize the process, or keep up with improvements to the builder as they are released.
 +
 +
=== Initial preparation ===
  
 
Download the balsa-builder [http://linux.lsdev.sil.org/gitweb?p=balsa-builder.git;a=snapshot;h=refs/tags/stable;sf=tbz2 tar file] and unpack it into your home directory somewhere:
 
Download the balsa-builder [http://linux.lsdev.sil.org/gitweb?p=balsa-builder.git;a=snapshot;h=refs/tags/stable;sf=tbz2 tar file] and unpack it into your home directory somewhere:
Line 42: Line 48:
  
 
  git clone <nowiki>git://git.lsdev.sil.org/balsa-builder.git</nowiki>
 
  git clone <nowiki>git://git.lsdev.sil.org/balsa-builder.git</nowiki>
 +
 +
To keep this updated in the future, you will just need to run:
 +
 +
git pull
 +
 +
=== Basic usage ===
  
 
Insert the Xubuntu CD (but don't run it).
 
Insert the Xubuntu CD (but don't run it).
Line 57: Line 69:
 
This command will install BALSA on an SD card. Note that you only need to build once. You can install as many times as you like.
 
This command will install BALSA on an SD card. Note that you only need to build once. You can install as many times as you like.
  
==== Support ====
+
=== Advanced usage ===
 
 
Bugs may be reported using the [http://linux.lsdev.sil.org/bugzilla/buglist.cgi?cmdtype=runnamed&namedcmd=BALSA BALSA Bugzilla database]. Please check to see if the same or a similar bug exists in the database before adding a new one.
 
 
 
If you have any difficulty following these instructions, or have questions that are not covered here, you can contact the team in these ways:
 
 
 
* Leave comments on the ''Discussion'' tab associated with this page (requires registration). Please sign your comments using the "add signature" button in the editing toolbar.
 
* Use our [http://linux.lsdev.sil.org/irc IRC channel].
 
* Send a message to ... at sil.org
 
 
 
Running the builder produces a file named ''latest_log''. Including this in queries will help us to address any difficulties. When using IRC or the discussion tab, we recommend uploading the file to a service like [http://pastebin.com/ pastebin.com] and pasting the resulting URL.
 
 
 
==== Advanced ====
 
  
 
If at any time you wish to run individual parts of the installer, you can put one or more of the following words after the script name:
 
If at any time you wish to run individual parts of the installer, you can put one or more of the following words after the script name:
Line 103: Line 103:
 
  ./build-balsa.sh teapot balsa
 
  ./build-balsa.sh teapot balsa
  
=== Booting ===
+
=== Customizing the build ===
 +
 
 +
''[under construction]''
 +
 
 +
== Booting ==
  
 
The card is ready to be put into an XO and booted. A non-XO system will need some separate preparation.
 
The card is ready to be put into an XO and booted. A non-XO system will need some separate preparation.
Line 112: Line 116:
 
* [[booting a Linux SD card from Xandros Linux]]
 
* [[booting a Linux SD card from Xandros Linux]]
  
=== Customizing the buildfile ===
+
== Support ==
 +
 
 +
Bugs may be reported using the [http://linux.lsdev.sil.org/bugzilla/buglist.cgi?cmdtype=runnamed&namedcmd=BALSA BALSA Bugzilla database]. Please check to see if the same or a similar bug exists in the database before adding a new one.
  
''[under construction]''
+
=== Contacting the developers ===
 +
 
 +
If you have any difficulty following these instructions, or have questions that are not covered here, you can contact the team in these ways:
  
=== Notes for Specific Applications Running Under BALSA ===
+
* Leave comments on the ''Discussion'' tab associated with this page (requires registration). Please sign your comments using the "add signature" button in the editing toolbar.
 +
* Use our [http://linux.lsdev.sil.org/irc IRC channel].
 +
* Send a message to ... at sil.org
  
* [[KMFL under BALSA - SCIM version]]
+
Running the builder produces a file named ''latest_log''. Including this in queries will help us to address any difficulties. When using IRC or the discussion tab, we recommend uploading the file to a service like [http://pastebin.com/ pastebin.com] and pasting the resulting URL.
* [[printing with BALSA]]
 
  
=== Known Bugs ===
+
=== Known bugs ===
  
 
''Undetectable errors are infinite in variety, in contrast to detectable errors, which by definition are limited'' — Gilb's 3rd Law of Unreliability
 
''Undetectable errors are infinite in variety, in contrast to detectable errors, which by definition are limited'' — Gilb's 3rd Law of Unreliability
Line 128: Line 137:
  
 
Consult the [http://linux.lsdev.sil.org/bugzilla/buglist.cgi?cmdtype=runnamed&namedcmd=BALSA BALSA Bugzilla database] for an up-to-date list of outstanding bugs.
 
Consult the [http://linux.lsdev.sil.org/bugzilla/buglist.cgi?cmdtype=runnamed&namedcmd=BALSA BALSA Bugzilla database] for an up-to-date list of outstanding bugs.
 +
 +
== Notes for Specific Applications Running Under BALSA ==
 +
 +
* [[KMFL under BALSA - SCIM version]]
 +
* [[printing with BALSA]]
  
 
[[Category:Low-Power Computing]]
 
[[Category:Low-Power Computing]]

Revision as of 17:27, 14 June 2010

Introduction

So far, SIL has produced two prototypes of BALSA:

  1. Based on Xubuntu Intrepid, created by installing Xubuntu to a real system.
  2. Based on Xubuntu Jaunty, created using an automated builder process.

Prototype 1 (Intrepid)

This is available by downloading a tarball from the main BALSA site. This tarball is installed onto a newly-formatted SD card. It can be done on the XO itself by putting the tarball onto a USB flash drive and following the instructions.

The tarball was produced by a manual process which involved installing Xubuntu to a real system, adding users and installing packages, and then saving the result.

This prototype is described on the main site, so isn't described any further here.

Prototype 2 (Jaunty)

This prototype can also use the tarball distribution mechanism. However, due to the use of an automated builder that is driven by a description called a "buildfile", it is open to customization through editing of the buildfile before running the builder process.

The rest of this page refers to Prototype 2.

The BALSA User Environment

The BALSA user environment uses the launcher-based UI with a tabbed taskbar. There are six tabs:

  1. Work (screenshot)
  2. Write & Draw (screenshot)
  3. Learning & Fun (screenshot)
  4. Record & Play (screenshot)
  5. Internet (screenshot)
  6. Settings (screenshot)

Running the Builder

Notes:

  1. You will need a Xubuntu Jaunty CD. You can download the required tools from xubuntu.org.
  2. This process is meant to be undertaken by a maintainer or distributor of BALSA only. It is not intended to be performed by language advisers or on-site technicians. They should simply download the finished image for installation to an SD card. (To do this, they can use the same process described on the main BALSA site, using the latest.tbz2 file that is created by the builder).
  3. The builder itself is about 25MB, and will download another 150MB as it runs. This is in addition to downloading the Xubuntu CD, which is about 650MB. The total download size is slightly larger than for downloading a built image, so using the builder is useful only if you want to customize the process, or keep up with improvements to the builder as they are released.

Initial preparation

Download the balsa-builder tar file and unpack it into your home directory somewhere:

tar -xpf balsa-builder.tbz2

Alternatively, you can obtain an up-to-the-minute version of balsa-build using git as follows:

git clone git://git.lsdev.sil.org/balsa-builder.git

To keep this updated in the future, you will just need to run:

git pull

Basic usage

Insert the Xubuntu CD (but don't run it).

Open a terminal and use cd to get to the newly created balsa-builder directory. Run this command:

./build-balsa.sh

This command will build a BALSA installation. Follow the instructions on screen.

You may then run this command:

./build-balsa.sh install

This command will install BALSA on an SD card. Note that you only need to build once. You can install as many times as you like.

Advanced usage

If at any time you wish to run individual parts of the installer, you can put one or more of the following words after the script name:

Command      Description
prerequisites Makes sure you have the right programs installed to build BALSA
image Creates the starting system image. Plain Xubuntu.
teapot Modifies the plain Xubuntu image to make it XO compatible
balsa Modifies the XO compatible image to make it BALSA
install Installs to an SD card (currently broken, use these instructions instead: Installing a BALSA build onto a SD card)

For example, you could redo the Teapot and BALSA process without creating a new image like this:

./build-balsa.sh teapot balsa

Customizing the build

[under construction]

Booting

The card is ready to be put into an XO and booted. A non-XO system will need some separate preparation.

There are separate pages for:

Support

Bugs may be reported using the BALSA Bugzilla database. Please check to see if the same or a similar bug exists in the database before adding a new one.

Contacting the developers

If you have any difficulty following these instructions, or have questions that are not covered here, you can contact the team in these ways:

  • Leave comments on the Discussion tab associated with this page (requires registration). Please sign your comments using the "add signature" button in the editing toolbar.
  • Use our IRC channel.
  • Send a message to ... at sil.org

Running the builder produces a file named latest_log. Including this in queries will help us to address any difficulties. When using IRC or the discussion tab, we recommend uploading the file to a service like pastebin.com and pasting the resulting URL.

Known bugs

Undetectable errors are infinite in variety, in contrast to detectable errors, which by definition are limited — Gilb's 3rd Law of Unreliability

Some of the applications included with BALSA have dialog boxes that are too large for netbook screens. If you hold down the <ALT> key while dragging the dialogue box, you can move the portions of the box that are off the screen onto the screen. Use this work-around to get access to buttons that are off the screen.

Consult the BALSA Bugzilla database for an up-to-date list of outstanding bugs.

Notes for Specific Applications Running Under BALSA