XCSoar README
=============

XCSoar is a tactical glide computer for the Pocket PC operating
system.

This file is aimed at developers.  Users should read the manual which
can be found on the XCSoar home page (http://www.xcsoar.org/).


Getting the source
------------------

The XCSoar source code is managed with git (http://git-scm.com/).  It
can be downloaded with the following command:

 git clone git://git.xcsoar.org/xcsoar/master/xcsoar.git

To update your repository, type:

 git pull

For more information, please refer to the git documentation.


Compiling from source
---------------------

To compile from source, you need:

- GNU make
- GNU compiler collection (gcc), version 4.6.2 or later
  or clang/LLVM 3.1 (with "make CLANG=y")
- rsvg (http://librsvg.sourceforge.net/)
- ImageMagick 6.4 (http://www.imagemagick.org/)
- xsltproc (http://xmlsoft.org/XSLT/xsltproc2.html)
- Perl and XML::Parser

To cross-compile to (desktop) Windows, you need the mingw-w64 version of gcc:

 http://mingw-w64.sourceforge.net/

For Pocket PC / Windows CE / Windows Mobile, you need mingw32ce:

 http://max.kellermann.name/download/xcsoar/devel/cegcc/

For Linux/Unix, you need:

- Boost (http://www.boost.org/)
- zlib (http://www.zlib.net/)
- CURL (http://curl.haxx.se/)
- SDL (http://www.libsdl.org/)
- SDL_ttf (http://www.libsdl.org/projects/SDL_ttf/)
- SDL_image (http://www.libsdl.org/projects/SDL_image/)
- OpenGL
- to run XCSoar, you need one of the following fonts (Debian package):
  DejaVu (ttf-dejavu), Droid (ttf-droid), Freefont (ttf-freefont)

For Android, you need:

- Android SDK (http://developer.android.com/sdk/)
- Android NDK r7 (http://developer.android.com/sdk/ndk/)
- Ogg Vorbis (http://www.vorbis.com/)

For Mac OS X, you need:
- GCC 4.6.2 or newer (http://hpc.sourceforge.net/, or homebrew, or Macports)
- Boost (http://www.boost.org/)
- zlib (http://www.zlib.net/)
- CURL (http://curl.haxx.se/)
- SDL (http://www.libsdl.org/)
- SDL_ttf (http://www.libsdl.org/projects/SDL_ttf/)
- SDL_image (http://www.libsdl.org/projects/SDL_image/)
- libicns (http://icns.sourceforge.net/)

To compile for the Mac, run

 ./configure
 make

To compile, run:

 make TARGET=<target>

Supported targets:

 PC: desktop Windows

 PPC2000, PPC2003: Pocket PC (for PPC2002 devices, use PPC2000 target)

 WM5: Windows Mobile 5.0 and later

 PPC2003X: Pocket PC 2003 with XScale CPU

 ALTAIR: Triadis Altair

 WINE: WineLib (experimental)

 UNIX: Linux and others (work in progress)

 ANDROID: Android OS

 ANDROID7: Android with ARMv7 CPU

 ANDROID86: Android with x86 CPU


Submitting patches
------------------

Submit patches to the XCSoar developer mailing list
([email protected]).

- patches should be self-contained
- patches should be self-documenting (add a good description on what
  is changed, and why you are changing it)
- write one patch for one change