Copyright (C) 2007 Nokia Corporation All rights reserved. RELEASE INFORMATION Project: maemo 4.0 'chinook' Development Platform Version: 4.0 Baseline: ITOS Chinook Date: 2007-09-17 This INSTALL.txt file explains how to install and set up the maemo 4.0 beta development environment on your computer. This document is targeted for maemo developers. 1. UPDATING EXISTING SCRATCHBOX INSTALLATION ============================================ If you are currently using an older Scratchbox 0.9.X version you will need to upgrade to the latest Scratchbox Apophis r4. The recommended method is to remove old Scratchbox installation completely and to remove /scratchbox directory before installing the new version of Scratchbox. IMPORTANT: For maemo 2.1 users it is strongly recommended that you take a full backup of your Scratchbox development environment and related files before upgrading to the new version of Scratchbox. WARNING: Remember to stop scratchbox service before removing the scratchbox directory. This will unmount scratchbox bind mounts and thus prevent removing files from your host system. If you choose not to remove your old installation, refer to the following document for instructions on how to upgrade scratchbox. Upgrading is explained in Chapter 5.2 in the document "Installing Scratchbox" in the scratchbox.org website: http://scratchbox.org/documentation/user/scratchbox-1.0/html/installdoc.html 2. SCRATCHBOX APOPHIS R4 INSTALLATION ===================================== This chapter is for developers who do not have Scratchbox Apophis R4 installed on their computer yet. You can install Scratchbox in two ways: - using the installer script (recommended), or - manually It is strongly advised to use the Scratchbox installer script as explained in chapter 2.1. If for some reason you want to, or need to install Scratchbox manually jump to chapter 2.2. 2.1 Installing Scratchbox using the installer script This maemo release includes an installer script which will download and install the required version of scratchbox to your host computer. The installer script can be found from this URL: http://repository.maemo.org/unstable/chinook-beta/maemo-scratchbox-install_4.0beta.sh To install scratchbox, first download the script (from the same directory where you found this INSTALL.txt file) to your host computer and run the maemo-scratchbox-install_4.0beta.sh as user root: $ sudo chmod a+x ./maemo-scratchbox-install_4.0beta.sh $ sudo ./maemo-scratchbox-install_4.0beta.sh This is the easiest way to install scratchbox, and it is also the recommended way. Follow the instructions given by the script. Running the script will not modify any files outside its given install path. Downloaded files are temporarily stored in /tmp directory. These can be safely removed after the installer has completed. On Debian based distributions: the install script will use Debian packages. Packages install to the default path, /scratchbox. On any other Linux distribution: the install script will use .tar.gz files which can be installed to any given path. Scratchbox installation should be separate from host system's tools, e.g. to /scratchbox or /opt/scratchbox. Specify users to be added to scratchbox users with '-u USER' option. You will need to start a new login terminal after being added to the group for group membership to be effective. After the installer has finished you should have a working Scratchbox environment ready. In a rare situation, if the installer can not work properly on your system you may have to do a manual installation. This is explained in chapter 2.2 below. 2.2 Installing Scratchbox Apophis manually If you have installed Scratchbox with the script mentioned above in chapter 2.1 then you can skip this chapter. You need to install the following packages: scratchbox-core 1.0.8 scratchbox-libs 1.0.8 scratchbox-devkit-cputransp 1.0.3 scratchbox-devkit-debian 1.0.9 scratchbox-devkit-doctools 1.0.7 scratchbox-devkit-maemo3 1.0.1 scratchbox-devkit-perl 1.0.4 scratchbox-toolchain-cs2005q3.2-glibc2.5-arm 1.0.7.2 scratchbox-toolchain-cs2005q3.2-glibc2.5-i386 1.0.7 These packages can be downloaded from the scratchbox.org server. http://scratchbox.org/download/files/sbox-releases/apophis/ Detailed instructions on how to install Scratchbox to your computer are at: http://scratchbox.org/documentation/user/scratchbox-1.0/html/installdoc.html 3. INSTALLING MAEMO 4.0BETA SDK ================================ The install script downloads the rootstraps for both ARMEL and i386 and sets up the targets inside Scratchbox. You need to have Scratchbox Apophis r4 installed on your machine before using the installer script. To install the SDK, first download the script from the same directory where you found this INSTALL.txt file. The name of the script is: maemo-sdk-install_4.0beta.sh After you have downloaded the script to your local machine, run the script outside of the Scratchbox environment: $ bash maemo-sdk-install_4.0beta.sh Running the script starts the installation. NOTE: If you have existing Scratchbox targets named SDK_BETA_ARMEL or SDK_BETA_X86, you need to give the '-y' option for the script to force reset of your targets: $ bash maemo-sdk-install_4.0beta.sh -y If your scratchbox is installed in a path alternative to /scratchbox, then specify this alternative path using the '-s PATH' option. 4. INSTALLING XEPHYR X11-SERVER =============================== You need to install the Xephyr X11 server software to your computer before you can run applications inside maemo 4.0 beta SDK. Xephyr is an X11 server that provides a device screen for the developer so that you can see all the maemo application windows and visuals on your computer. Xephyr is not included in the SDK, and should be installed to the host system. 4.1 Getting Xephyr Xephyr can for example be found at: http://packages.debian.org/unstable/x11/xserver-xephyr On Debian-based Linux distributions you can install Xephyr by doing "apt-get install xserver-xephyr" outside scratchbox. 4.2 Xephyr startup parameters Xephyr requires command line parameters so that it can provide a real working window for the maemo environment. Start Xephyr outside Scratchbox with the following parameters: $ Xephyr :2 -host-cursor -screen 800x480x16 -dpi 96 -ac -extension Composite In the Scratchbox environment the DISPLAY variable has to be set so that it matches the display setting given above for the Xephyr server (parameter :2 in the above example). [sbox-SDK_BETA_X86:~] > export DISPLAY=:2 After the Xephyr server is running on the Linux host, you can start the Hildon Application Framework with the following command: [sbox-SDK_BETA_X86:~] > af-sb-init.sh start This should start the Hildon Application Framework inside the Xephyr window. Happy Hacking ! --- END