README

   1 =Basic instructions=
   2
   3 1. Copy config.sample.py to config.py and edit the path within accordingly
   4    to point to the Android tools
   5 2. Make a repo directory and put APK files in it
   6 3. Run update.py
   7 4. If it reports that any metadata files are missing, you can create them
   8    in the metadata directory and run it again.
   9 5. To ease creation of metadata files, run update.py with the -c option. It
  10    will create 'skeleton' metadata files that are missing, and you can then
  11    just edit them and fill in the details.
  12 6. Then, if you've changed things, run update.py again.
  13 7. Running update.py adds an Icons directory into the repo directory, and
  14    also creates the repository index (index.xml).
  15 8. Transfer the repo directory to the appropriate http server. The script
  16    in upload.sh is an example of how to do this.
  17
  18 =Build System Requirements=
  19
  20 To be able to auto-build packages, you're going to need:
  21
  22 *Linux
  23 *Python
  24 *A fully functional Android SDK with all SDK platforms and tools
  25 *The Android NDK
  26 *Ant
  27 *Ant Contrib Tasks (Debian package ant-contrib)
  28 *JavaCC (Debian package javacc)
  29 *VCS clients: svn, git, hg, bzr
  30 *A keystore for holding release keys. (Safe, secure and well backed up!)
  31
  32 You then need to create a config.py (copy config.sample.py and follow the
  33 instructions) to specify the locations of some of these things.
  34
  35 =MetaData=
  36
  37 Information used by update.py to compile the public index comes from two
  38 sources, 1) the APK files in the repo directory, and 2) the metadata files
  39 in the metadata directory.
  40
  41 The metadata files are simple, easy to edit text files, always named as the
  42 application's package ID with '.txt' appended. Within the file, the following
  43 fields are recognised:
  44
  45 ==License==
  46
  47 The license for the application.
  48
  49 Common values: GPLv2, GPLv2+, GPLv3, Apache2, MIT, BSD
  50
  51 ==Name==
  52
  53 The name of the application. Normally, this field should not be present since the
  54 application's correct name is retrieved from the APK file. However, in a situation
  55 where an APK contains a bad or missing application name, it can be overridden
  56 using this.
  57
  58 ==Web Site==
  59
  60 The URL for the application's web site.
  61
  62 ==Source Code==
  63
  64 The URL to view or obtain the application's source code. This should be
  65 something human-friendly. Machine-readable source-code is covered in the
  66 'Repo' field.
  67
  68 ==Issue Tracker==
  69
  70 The URL for the application's issue tracker. Optional, since not all
  71 applications have one.
  72
  73 ==Summary==
  74
  75 A brief summary of what the application is.
  76
  77 ==Description==
  78
  79 A full description of the application. This can span multiple lines, and is
  80 terminated by a line containing a single '.'.
  81
  82 ==Repo Type==
  83
  84 The type of repository - for automatic building from source. If this is not
  85 specified, automatic building is disabled for this application. Possible
  86 values are:
  87
  88   git, svn, hg, bzr
  89
  90 ==Repo==
  91
  92 The repository location. Usually a git: or svn: URL.
  93
  94 Normally the repository is checked out once for the application, then moved
  95 to a particular revision/commit/tag for each build version. For an SVN
  96 repository though, this behaviour can be changed by appending a * to the
  97 repository URL - in this case the repository is checked out once per build
  98 version, with the subdir parameter in place of the *. This can be beneficial
  99 when dealing with very large SVN repositories.
 100
 101 For a Subversion repo that requires authentication, you can precede the repo
 102 URL with username:password@ and those parameters will be passed as --username
 103 and --password to the SVN checkout command.
 104
 105 ==Build Version==
 106
 107 Any number of these fields can be present, each specifying a version to
 108 automatically build from source. The value is a comma-separated list.
 109 For example:
 110
 111     Build Version:0.12,3,651696a49be2cd7db5ce6a2fa8185e31f9a20035
 112
 113 The above specifies to build version 0.12, which has a version code of 3.
 114 The third parameter specifies the tag, commit or revision number from
 115 which to build it in the source repository.
 116
 117 In addition to the three, always required, parameters described above,
 118 further parameters can be added (in name=value format) to apply further
 119 configuration to the build. These are:
 120
 121  subdir=<path>   - Specifies to build from a subdirectory of the checked out
 122                    source code. Normally this directory is changed to before
 123                    building, but there is a special case for SVN repositories
 124                    where the URL is specified with a * at the end. See the
 125                    documentation for the Repo field for more information.
 126  bindir=<path>   - Normally the build output (apk) is expected to be in the
 127                    bin subdirectory below the ant build files. If the project
 128                    is configured to put it elsewhere, that can be specified
 129                    here, relative to the base of the checked out repo..
 130  oldsdkloc=yes   - The sdk location in the repo is in an old format
 131  target=<target> - Specifies a particular SDK target, when the source doesn't.
 132                    This is likely to cause the whole build.xml to be rewritten,
 133                    which is fine if it's a 'standard' android file or doesn't
 134                    already exist, but not a good idea if it's heavily
 135                    customised.
 136  rm=<relpath>    - Specifies the relative path of file to delete before the
 137                    build is done. The path is relative to the base of the
 138                    build directory - i.e. the directory that contains
 139                    AndroidManifest.xml.
 140  antcommand=xxx  - Specify an alternate ant command (target) instead of the
 141                    default 'release'.
 142  insertversion=x - If specified, the pattern 'x' in the AndroidManifest.xml is
 143                    replaced with the version number for the build.
 144  insertvercode=x - If specified, the pattern 'x' in the AndroidManifest.xml is
 145                    replaced with the version code for the build.
 146  update=no         By default, 'android update project' is used to generate or
 147                    update the build.xml file. Specifying update=no bypasses
 148                    that.
 149  initfun=yes       Enables a selection of mad hacks to make com.funambol.android
 150                    build. Probably not useful for any other application.
 151  buildjni=yes      Enables building of native code via the ndk-build script before
 152                    doing the main ant build.
 153
 154 Another example, using extra parameters:
 155
 156     Build Version:1.09.03,10903,45,subdir=Timeriffic,oldsdkloc=yes
 157
 158 ==Use Built==
 159
 160 Set this to "Yes" to use built versions of the application for the repository.
 161 Currently, this just triggers update.py to copy the relevant apks and tarballs
 162 from the 'built' directory before updating the repo index.
 163
 164 ==AntiFeatures==
 165
 166 This is optional - if present, it contains a comma-separated list of any of
 167 the following values, describing an AntiFeature the application has:
 168
 169   "Ads" - the application contains advertising
 170   "Tracking" - the application tracks and reports your activity to somewhere
 171   "NonFreeNet" - the application promotes a non-Free network service
 172   "NonFreeAdd" - the application promotes non-Free add-ons
 173
 174 ==Disabled==
 175
 176 If this field is present, the application does not get put into the public
 177 index. This allows metadata to be retained while an application is temporarily
 178 disabled from being published. The value should be a description of why the
 179 application is disabled.
 180