Difference between revisions of "Sugar"

From ArchWiki
Jump to: navigation, search
(update Pkg/AUR templates (https://github.com/lahwaacz/wiki-scripts/blob/master/update-package-templates.py))
 
(22 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
[[Category:Desktop environments]]
 
[[Category:Desktop environments]]
[[Category:Desktop environments (Русский)]]
 
 
[[it:Sugar]]
 
[[it:Sugar]]
A product of the [http://en.wikipedia.org/wiki/One_Laptop_per_Child OLPC] initiative, [http://en.wikipedia.org/wiki/Sugar_(GUI) Sugar] is a Desktop Environment akin to [[KDE]] and [[GNOME]], but geared towards children and education. If you have a young son, daughter, brother, sister, puppy or alien, the best way to introduce them to the world of Arch Linux is by deploying an Arch/Sugar platform and then forgetting about it.
+
[[ja:Sugar]]
 +
A product of the [[Wikipedia:One Laptop per Child|OLPC]] initiative, [[Wikipedia:Sugar (software)|Sugar]] is a Desktop Environment akin to [[KDE]] and [[GNOME]], but geared towards children and education. If you have a young son, daughter, brother, sister, puppy or alien, the best way to introduce them to the world of Arch Linux is by deploying an Arch/Sugar platform and then forgetting about it.
  
But wait..where art thou, O Sugar?
+
Sugar has a special [http://wiki.sugarlabs.org/go/Taxonomy Taxonomy] to name the parts of its system. The graphical interface itself constitute the '''Glucose''' group. This is the core system can reasonably expect to be present when installing Sugar. But to really use the environment, you need activities (some sort of applications). Base activities are part of '''Fructose'''. Then, '''Sucrose''' is constituted by both Glucose and Fructose and represents what should be distributed as a basic sugar desktop environment. Extra activities are part of '''Honey'''. Note that Ribose (the underlaying operating system) is here replaced by Arch.
  
That's right. To lead such a good life, you need at least some Sugar-related packages in at least [[AUR]].
+
== Installation ==
  
Sugar has a special [http://wiki.sugarlabs.org/go/Taxonomy Taxonomy] to name the parts of its system. The desktop itself constitute the '''glucose''' group. This is the basic system an activity can reasonably expect to be present when installing Sugar. But to really use the environment, you need activities. Basic and sample activities are part of '''fructose'''. Then, '''sucrose''' is constituted by both {{Ic|glucose}} and {{Ic|fructose}} and represents what should be distributed as a basic sugar desktop environment. Note that {{Ic|ribose}} (the underlaying operating system) is here replaced by Arch.{{Ic|Honey}} (the extra activities) are not currently provided in AUR but can be installed as shown in the [[#Building]] section.
+
{{Note|Sugar is on its way to the [[official repositories]]. Until this happens, packages are available in the unofficial [http://pkgbuild.com/~bgyorgy/city.html <nowiki>[city] repository</nowiki>] (see below).}}
  
== Getting started: Glucose ==
+
=== From [city] repository ===
=== Building from AUR ===
+
  
Install [https://aur.archlinux.org/packages.php?ID=32989 sugar] from the [[AUR]].
+
* For the core system (''Glucose''), install {{AUR|sugar}}, available in the [http://pkgbuild.com/~bgyorgy/city.html <nowiki>[city] repository</nowiki>]. It provides the graphical interface and a desktop session, but not very useful on its own.
 +
* The ''sugar-fructose'' group contains the base activities (''Fructose'') including a web browser, a text editor, a media player and a terminal emulator.
 +
* The {{AUR|sugar-runner}} package provides a helper script that makes it possible to launch Sugar within another desktop environment, or from the command line directly.
  
=== Building a Bundle ===
+
=== From AUR ===
[http://wiki.sugarlabs.org/go/Development_Team/Jhbuild This] is a cool build system provided by the developers that allows one to download and build Sugar ''almost'' in its entirety. You will be told what you need, and of course, it will not help if what you need has not yet been packaged for us mighty Archers.
+
  
The resulting project can then be offered as a bundle. This method of building should not be encouraged, since it is not "modular". A likely analogy is the [[E17#Installing_E17_using_easy_e17.sh|easy-e17 script]], except that we are in the opposite situation whereby there are no modular packages and thus no group - yet. Adding the provision is a safety measure, .eg:
+
Install {{AUR|sugar}} from the [[AUR]].
  
pkgname=sugar-bundle
+
''' Activities'''
pkgdesc="The Sugar environment and applications built with jhbuild"
+
provides=('sugar-desktop') # as in provides=('e')
+
conflicts=('sugar-desktop')
+
  
But as soon as someone uploads a component of the build/Sugar as a separate package, it must be part of the group (and the bundle package will automatically conflict), eg.:
+
Activities are available under name {{ic|sugar-activity-'''activity'''}}  from AUR.  
  
pkgname=sugar-toolkit
+
''' Etoys '''
pkgdesc="The Sugar environment toolkit"
+
groups=('sugar-desktop' 'sugar-desktop-base')
+
  
''Note: It might be possible to use the new split functions of makepkg here, in which case it will end up as a modular build :)''
+
{{Ic|etoys}} is provided separately as it is part of glucose but also include the fructose activity. It is available as {{AUR|etoys}} in AUR.
  
=== Depedency tree===
+
=== From Activity Library ===
Below is the dependency tree of sugar 0.86
+
|--sugar
+
    |--hicolor-icon-theme
+
    |--shared-mime-info
+
    |--metacity
+
    |--libwnck
+
    |--pygtksourceview2
+
    |--sugar-artwork
+
    |--python-xklavier
+
    |  |--libxklavier
+
    |  |--pygobject
+
    |  |--gtk2
+
    |--sugar-toolkit
+
      |--alsa-lib
+
      |--gnome-python-desktop
+
      |--hippo-canvas
+
      |  |--librsvg
+
      |    |--gtk2
+
      |    |--libcroco
+
      |--sugar-datastore
+
      |  |--dbus-python
+
      |  |--xapian-python-bindings
+
      |  |--python-cjson
+
      |  |--sugar-base
+
      |    |--pygobject
+
      |    |--python-decorator
+
      |--sugar-presence-service
+
          |--telepathy-gabble
+
          |--telepathy-salut
+
          |--python-telepathy
+
          |--sugar-base
+
          |  |--pygobject
+
          |  |--python-decorator
+
          |--gnome-python
+
            |--pygtk
+
            |--pyorbit
+
            |--libgnomeui
+
                |--libsm
+
  
=== Building a Modular Group ===
+
The [http://wiki.sugarlabs.org/go/Activity_Library Sugar Activity Library] provides many [http://wiki.sugarlabs.org/go/Development_Team/Almanac/Activity_Bundles Activity Bundles] packaged as zip files with the ".xo" extension. These bundles can be downloaded and installed to the user's directory from Sugar, but the installation does not ensure that the dependencies are satisfied. Therefore it's not the recommended way to install activities, because they likely fail to start due missing dependencies. Commonly used dependencies:
This is the more appropriate route to take. Here is the current list of noted dependencies, acquired by inspecting the build trees of distributions supported by Sugar (Gentoo in particular):
+
* For web activities, install {{Pkg|webkit2gtk}} from the official repositories.
 +
* For GTK+ 2 based activities, install {{AUR|sugar-toolkit}} from AUR.
  
# Syntax: pkgname .. :-> location + comment1 + comment2 ..
+
In order to check why the activity fails to start, look at the log file located at {{ic|~/.sugar/default/logs/[app_id]-1.log}}.
+
espeak :-> [community]
+
squeak :-> [unsupported]
+
evince :-> [extra]
+
pyabiword :-> [unsupported]
+
python-cjson :-> [community]
+
python-telepathy :-> [community]
+
gstreamer0.10-espeak :-> [unsupported]
+
olpcsound :-> [unsupported]
+
telepathy-glib :-> [community]
+
xulrunner :-> [extra]
+
telepathy-gabble :-> [community]
+
telepathy-salut :-> [community]
+
hippo-canvas :-> [unsupported]
+
  
== Activities ==
+
== Starting Sugar ==
  
=== Fructose ===
+
Sugar can be started either graphically, using a [[display manager]], or manually from the console.
  
All {{Ic|fructose}} activities are available on the AUR. To install them, you may issue
+
'''Graphically'''
yaourt sugar-activity
+
or equivalent and select the activities you want to install.
+
Currently provided activities are
+
browse
+
calculate
+
chat
+
imageviewer
+
jukebox
+
log
+
pippy
+
read
+
terminal
+
turtleart
+
write
+
etoys
+
  
=== Etoys ===
+
Select the session ''Sugar'' from the display manager's session menu.
  
{{Ic|etoys}} is provided separately as it is part of glucose but also include the fructose activity. You may install it using
+
'''Manually'''
yaourt -S etoys
+
or an equivalent AUR helper.
+
  
=== Building===
+
If {{AUR|sugar-runner}} installed, Sugar can be launched with the {{ic|sugar-runner}} command.
  
Now you have a working Sugar environment, it is time to populate it with activities such as a browser, a calculator, an image viewer or games and toys. They almost all have the same building procedure, a {{ic|setup.py}} that calls functions shipped with sugar. Below is a typical {{ic|PKGBUILD}}:
+
Alternative method is to add {{ic|exec sugar}} to the {{ic|~/.xinitrc}} file. After that, Sugar can be launched with the {{ic|startx}} command (see [[xinitrc]] for additional details).  After setting up the {{ic|~/.xinitrc}} file, it can also be arranged to [[Start X at login]].
 +
 
 +
== Packaging ==
 +
 
 +
Almost all activities have the same building procedure, a {{ic|setup.py}} that calls functions shipped with sugar. Below is a typical {{ic|PKGBUILD}}:
 
{{hc|PKGBUILD|2=
 
{{hc|PKGBUILD|2=
 
  # Contributor: Name <name@mail.com>
 
  # Contributor: Name <name@mail.com>
Line 143: Line 74:
 
# vim:set ts=2 sw=2 et:
 
# vim:set ts=2 sw=2 et:
 
}}
 
}}
You may need {{Ic|squeak}} to run some activities (like {{Ic|etoys}}).
 
  
 
===Notes===
 
===Notes===
Line 151: Line 81:
 
* I ''suggest'' that we prefix sugar activities packages in AUR with {{Ic|sugar-activity-}}.
 
* I ''suggest'' that we prefix sugar activities packages in AUR with {{Ic|sugar-activity-}}.
  
* You may need to install {{Ic|python-pygame}} if activities do not start up.
+
== See also ==
 +
 
 +
* [http://sugarlabs.org/ The Official Website of Sugar]
 +
* [http://activities.sugarlabs.org/ Activities for Sugar]

Latest revision as of 08:51, 6 February 2016

A product of the OLPC initiative, Sugar is a Desktop Environment akin to KDE and GNOME, but geared towards children and education. If you have a young son, daughter, brother, sister, puppy or alien, the best way to introduce them to the world of Arch Linux is by deploying an Arch/Sugar platform and then forgetting about it.

Sugar has a special Taxonomy to name the parts of its system. The graphical interface itself constitute the Glucose group. This is the core system can reasonably expect to be present when installing Sugar. But to really use the environment, you need activities (some sort of applications). Base activities are part of Fructose. Then, Sucrose is constituted by both Glucose and Fructose and represents what should be distributed as a basic sugar desktop environment. Extra activities are part of Honey. Note that Ribose (the underlaying operating system) is here replaced by Arch.

Installation

Note: Sugar is on its way to the official repositories. Until this happens, packages are available in the unofficial [city] repository (see below).

From [city] repository

  • For the core system (Glucose), install sugarAUR, available in the [city] repository. It provides the graphical interface and a desktop session, but not very useful on its own.
  • The sugar-fructose group contains the base activities (Fructose) including a web browser, a text editor, a media player and a terminal emulator.
  • The sugar-runnerAUR package provides a helper script that makes it possible to launch Sugar within another desktop environment, or from the command line directly.

From AUR

Install sugarAUR from the AUR.

Activities

Activities are available under name sugar-activity-activity from AUR.

Etoys

etoys is provided separately as it is part of glucose but also include the fructose activity. It is available as etoysAUR in AUR.

From Activity Library

The Sugar Activity Library provides many Activity Bundles packaged as zip files with the ".xo" extension. These bundles can be downloaded and installed to the user's directory from Sugar, but the installation does not ensure that the dependencies are satisfied. Therefore it's not the recommended way to install activities, because they likely fail to start due missing dependencies. Commonly used dependencies:

  • For web activities, install webkit2gtk from the official repositories.
  • For GTK+ 2 based activities, install sugar-toolkitAUR from AUR.

In order to check why the activity fails to start, look at the log file located at ~/.sugar/default/logs/[app_id]-1.log.

Starting Sugar

Sugar can be started either graphically, using a display manager, or manually from the console.

Graphically

Select the session Sugar from the display manager's session menu.

Manually

If sugar-runnerAUR installed, Sugar can be launched with the sugar-runner command.

Alternative method is to add exec sugar to the ~/.xinitrc file. After that, Sugar can be launched with the startx command (see xinitrc for additional details). After setting up the ~/.xinitrc file, it can also be arranged to Start X at login.

Packaging

Almost all activities have the same building procedure, a setup.py that calls functions shipped with sugar. Below is a typical PKGBUILD:

PKGBUILD
# Contributor: Name <name@mail.com>
pkgname=sugar-activity-calculate
_realname=Calculate
pkgver=30
pkgrel=1
pkgdesc="A calculator for Sugar."
arch=('i686' 'x86_64')
url="http://www.sugarlabs.org/"
license=('GPL')
groups=('sucrose' 'fructose')
depends=('sugar')
source=(http://download.sugarlabs.org/sources/sucrose/fructose/${_realname}/${_realname}-$pkgver.tar.bz2)
md5sums=('011bd911516f27d05194320164c7dcd7')

build() {
  cd "$srcdir/${_realname}-$pkgver"
  ./setup.py install --prefix="$pkgdir/usr" || return 1
}
# vim:set ts=2 sw=2 et:

Notes

  • Activity building procedure is not made for packaging and using --prefix can be dangerous if the application uses this path internally. I think the correct way to do this would be to patch the installation procedure in sugar so it accepts an argument such as --destdir=.
  • I suggest that we prefix sugar activities packages in AUR with sugar-activity-.

See also