Platform Team/Guide/Sweets Usage

From Sugar Labs
< Platform Team‎ | Guide
Revision as of 19:06, 15 March 2011 by Alsroot (talk | contribs)
Jump to navigation Jump to search

This guide describes how to use Sugar Labs' SDK for developing core modules.

Requirements

  • Install PackageKit and PackageKit authentication agent from native packages. On Debian-based systems, these packages are packagekit and packagekit-gnome (for Gnome Desktop Environment). For Fedora, PackageKit and gnome-packagekit.
  • PackageKit authentication agent should be launched to let the sweets command install dependencies. Usually it is started after being logged into a Desktop Environment session (it isn't for Sugar session).
  • Clone sweets sources and install it (after the first run you need to relogin to take into account new PATH value, then just run sweets command):
git clone --recursive git://git.sugarlabs.org/sdk/sweets.git
sweets/sweets upgrade

Launch sugar

To launch sugar session: 

sweets sdk/sugar

or to run from Xephyr: 

sweets sdk/sugar:emulator

Development workflow with sweets

During the first launch, sources will be auto-built and kept in internal storage. To make sweets useful for the code you are developing, register sources (sweets.recipe should exist in sources): 

sweets checkout [path-to-sources]

After that, sources might be launched via sweets by mentioning its sweet value. 

sweets your-sweet

Registered projects will be built according to [Build] section commands in recipe files. In general, for autotools-based projects, there is no further need for the sweets command, just run make install to build current sources and copy them to the directory that was specified by sweets in the configure stage.

For glucose projects, there is no need even in calling the make command, python code will be reused from its original place (see binding options in sweets.recipe files), change the code and restart sugar.

For activities, follow regular activity developing procedure - clone them to ~/Activities directory and run from sugar shell.

Run sweets from X session

Place sweets invocation into your ~/.xsession file: 

PATH=$HOME/.local/bin:$PATH
sweets sdk/sugar

and create a /usr/share/xsessions/sweets.desktop desktop file: 

[Desktop Entry]
Encoding=UTF-8
Name=Sweets
GenericName=Sweets
Exec=/etc/X11/Xsession
Type=Application

Current limitations

  • For now, sweets knowns only about glucose dependencies to install them from native packages in Debian, Ubuntu, Fedora, Mandriva, openSUSE, and Gentoo.
  • Activities can't reuse sweets benefits.

Feedback

Retrieved from "https://wiki.sugarlabs.org/index.php?title=Platform_Team/Guide/Sweets_Usage&oldid=63617"