README

   1 XCSoar README
   2 =============
   3
   4 XCSoar is a tactical glide computer for Android, Linux, Mac OS X,
   5 Windows and Windows CE/Mobile.
   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://git.xcsoar.org/xcsoar/master/xcsoar.git
  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 Please read the developer manual for detailed build instructions.  You
  30 can download it on the XCSoar website:
  31
  32  http://www.xcsoar.org/discover/manual.html
  33
  34
  35 Submitting patches
  36 ------------------
  37
  38 Subscribe to the XCSoar developer mailing list:
  39
  40  https://lists.sourceforge.net/lists/listinfo/xcsoar-devel
  41  xcsoar-devel@lists.sourceforge.net
  42
  43 Use this mailing list to submit patches or "git pull" requests.
  44
  45 - patches should be self-contained
  46 - patches should be self-documenting (add a good description on what
  47   is changed, and why you are changing it)
  48 - write one patch for one change