README

   1 XCSoar README
   2 =============
   3
   4 XCSoar is a tactical glide computer for the Pocket PC operating
   5 system.
   6
   7 This file is aimed at developers.  Users should read the manual which
   8 can be found on the XCSoar home page (http://www.xcsoar.org/).
   9
  10
  11 Getting the source
  12 ------------------
  13
  14 The XCSoar source code is managed with git (http://git-scm.com/).  It
  15 can be downloaded with the following command:
  16
  17  git clone git://xcsoar.git.sourceforge.net/gitroot/xcsoar/xcsoar
  18
  19 To update your repository, type:
  20
  21  git pull
  22
  23 For more information, please refer to the git documentation.
  24
  25
  26 Compiling from source
  27 ---------------------
  28
  29 To compile from source, you need:
  30
  31 - GNU make
  32 - GNU compiler collection (gcc)
  33 - rsvg (http://librsvg.sourceforge.net/)
  34 - ImageMagick 6.4 (http://www.imagemagick.org/)
  35 - xsltproc (http://xmlsoft.org/XSLT/xsltproc2.html)
  36
  37 To cross-compile to (desktop) Windows, you need the mingw32 version of
  38 gcc:
  39
  40  http://www.mingw.org/
  41
  42 For Pocket PC / Windows CE / Windows Mobile, you need mingw32ce:
  43
  44  http://cegcc.sourceforge.net/
  45  http://sourceforge.net/projects/cegcc/files/cegcc/0.59.1/mingw32ce-0.59.1.tar.bz2/download
  46
  47 For Linux/Unix, you need:
  48
  49 - Boost (http://www.boost.org/)
  50 - zlib (http://www.zlib.net/)
  51 - OpenGL
  52
  53 For Android, you need:
  54
  55 - Android SDK (http://developer.android.com/sdk/)
  56 - Android NDK r5b (http://developer.android.com/sdk/ndk/)
  57
  58 To compile, run:
  59
  60  make TARGET=PC
  61
  62 Supported targets:
  63
  64  PC: desktop Windows
  65
  66  PPC2000, PPC2003: Pocket PC (for PPC2002 devices, use PPC2000 target)
  67
  68  WM5: Windows Mobile 5.0 and later
  69
  70  PPC2003X: Pocket PC 2003 with XScale CPU
  71
  72  ALTAIR: Triadis Altair
  73
  74  WINE: WineLib (experimental)
  75
  76  UNIX: Linux and others (work in progress)
  77
  78  ANDROID: Android OS (work in progress)
  79
  80
  81 Submitting patches
  82 ------------------
  83
  84 Submit patches to the XCSoar developer mailing list
  85 (xcsoar-devel@lists.sourceforge.net).
  86
  87 - patches should be self-contained
  88 - patches should be self-documenting (add a good description on what
  89   is changed, and why you are changing it)
  90 - write one patch for one change