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 Also make sure the SDK tools - found in $SDK/tools/ - are in your $PATH.
  35
  36 =MetaData=
  37
  38 Information used by update.py to compile the public index comes from two
  39 sources, 1) the APK files in the repo directory, and 2) the metadata files
  40 in the metadata directory.
  41
  42 The metadata files are simple, easy to edit text files, always named as the
  43 application's package ID with '.txt' appended. Within the file, the following
  44 fields are recognised:
  45
  46 ==License==
  47
  48 The license for the application.
  49
  50 Common values: GPLv2, GPLv2+, GPLv3, Apache2, MIT, BSD
  51
  52 ==Name==
  53
  54 The name of the application. Normally, this field should not be present since the
  55 application's correct name is retrieved from the APK file. However, in a situation
  56 where an APK contains a bad or missing application name, it can be overridden
  57 using this.
  58
  59 ==Web Site==
  60
  61 The URL for the application's web site.
  62
  63 ==Source Code==
  64
  65 The URL to view or obtain the application's source code. This should be
  66 something human-friendly. Machine-readable source-code is covered in the
  67 'Repo' field.
  68
  69 ==Issue Tracker==
  70
  71 The URL for the application's issue tracker. Optional, since not all
  72 applications have one.
  73
  74 ==Donate==
  75
  76 The URL to donate to the project. This could be the project's donate page
  77 if it has one, or perhaps even a direct PayPal link.
  78
  79 ==Summary==
  80
  81 A brief summary of what the application is.
  82
  83 ==Description==
  84
  85 A full description of the application. This can span multiple lines, and is
  86 terminated by a line containing a single '.'.
  87
  88 ==Repo Type==
  89
  90 The type of repository - for automatic building from source. If this is not
  91 specified, automatic building is disabled for this application. Possible
  92 values are:
  93
  94   git, svn, hg, bzr
  95
  96 ==Repo==
  97
  98 The repository location. Usually a git: or svn: URL.
  99
 100 Normally the repository is checked out once for the application, then moved
 101 to a particular revision/commit/tag for each build version. For an SVN
 102 repository though, this behaviour can be changed by appending a * to the
 103 repository URL - in this case the repository is checked out once per build
 104 version, with the subdir parameter in place of the *. This can be beneficial
 105 when dealing with very large SVN repositories.
 106
 107 For a Subversion repo that requires authentication, you can precede the repo
 108 URL with username:password@ and those parameters will be passed as --username
 109 and --password to the SVN checkout command.
 110
 111 ==Build Version==
 112
 113 Any number of these fields can be present, each specifying a version to
 114 automatically build from source. The value is a comma-separated list.
 115 For example:
 116
 117     Build Version:0.12,3,651696a49be2cd7db5ce6a2fa8185e31f9a20035
 118
 119 The above specifies to build version 0.12, which has a version code of 3.
 120 The third parameter specifies the tag, commit or revision number from
 121 which to build it in the source repository.
 122
 123 In addition to the three, always required, parameters described above,
 124 further parameters can be added (in name=value format) to apply further
 125 configuration to the build. These are:
 126
 127  subdir=<path>   - Specifies to build from a subdirectory of the checked out
 128                    source code. Normally this directory is changed to before
 129                    building, but there is a special case for SVN repositories
 130                    where the URL is specified with a * at the end. See the
 131                    documentation for the Repo field for more information.
 132  bindir=<path>   - Normally the build output (apk) is expected to be in the
 133                    bin subdirectory below the ant build files. If the project
 134                    is configured to put it elsewhere, that can be specified
 135                    here, relative to the base of the checked out repo..
 136  oldsdkloc=yes   - The sdk location in the repo is in an old format, or the
 137                    build.xml is expecting such. The 'new' format is sdk.dir
 138                    while the VERY OLD format is sdk-location. Typically, if
 139                    you get a message along the lines of:
 140                       "com.android.ant.SetupTask cannot be found"
 141                    when trying to build, then try enabling this option.
 142  target=<target> - Specifies a particular SDK target, when the source doesn't.
 143                    This is likely to cause the whole build.xml to be rewritten,
 144                    which is fine if it's a 'standard' android file or doesn't
 145                    already exist, but not a good idea if it's heavily
 146                    customised.
 147  rm=<relpath>    - Specifies the relative path of file to delete before the
 148                    build is done. The path is relative to the base of the
 149                    build directory - i.e. the directory that contains
 150                    AndroidManifest.xml.
 151  antcommand=xxx  - Specify an alternate ant command (target) instead of the
 152                    default 'release'.
 153  insertversion=x - If specified, the pattern 'x' in the AndroidManifest.xml is
 154                    replaced with the version number for the build.
 155  insertvercode=x - If specified, the pattern 'x' in the AndroidManifest.xml is
 156                    replaced with the version code for the build.
 157  update=no         By default, 'android update project' is used to generate or
 158                    update the build.xml file. Specifying update=no bypasses
 159                    that.
 160  initfun=yes       Enables a selection of mad hacks to make com.funambol.android
 161                    build. Probably not useful for any other application.
 162  buildjni=yes      Enables building of native code via the ndk-build script before
 163                    doing the main ant build.
 164  submodules=yes    Use if the project (git only) has submodules - causes git
 165                    submodule init and update to be executed after the source is
 166                    cloned.
 167  encoding=xxxx     Adds a java.encoding property to local.properties with the given
 168                    value. Generally the value will be 'utf-8'. This is picked up by
 169                    the SDK's ant rules, and forces the Java compiler to interpret
 170                    source files with this encoding. If you receive warnings during
 171                    the compile about character encodings, you probably need this.
 172  prebuild=xxxx     Specifies a shell command (or commands - chain with &&) to run
 173                    before the build takes place - the only proviso being that you
 174                    can't use commas in the command.
 175  novcheck=yes      Don't check that the version name and code in the resulting apk
 176                    are correct by looking at the build output - assume the metadata
 177                    is correct. This takes away a useful level of sanity checking, and
 178                    should only be used if the values can't be extracted.
 179  fixtrans=yes      Modifies any instances of string resources that use multiple
 180                    formatting arguments, but don't use positional notation. For
 181                    example, "Hello %s, %d" becomes "Hello %1$s, %2$d". Newer versions
 182                    of the Android platform tools enforce this sensible standard. If you
 183                    get error messages relating to that, you need to enable this.
 184
 185 Another example, using extra parameters:
 186
 187     Build Version:1.09.03,10903,45,subdir=Timeriffic,oldsdkloc=yes
 188
 189 ==Use Built==
 190
 191 Set this to "Yes" to use built versions of the application for the repository.
 192 Currently, this just triggers update.py to copy the relevant apks and tarballs
 193 from the 'built' directory before updating the repo index.
 194
 195 ==AntiFeatures==
 196
 197 This is optional - if present, it contains a comma-separated list of any of
 198 the following values, describing an AntiFeature the application has:
 199
 200   "Ads" - the application contains advertising
 201   "Tracking" - the application tracks and reports your activity to somewhere
 202   "NonFreeNet" - the application promotes a non-Free network service
 203   "NonFreeAdd" - the application promotes non-Free add-ons
 204
 205 ==Disabled==
 206
 207 If this field is present, the application does not get put into the public
 208 index. This allows metadata to be retained while an application is temporarily
 209 disabled from being published. The value should be a description of why the
 210 application is disabled.
 211