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 =MetaData=
  19
  20 Information used by update.py to compile the public index comes from two
  21 sources, 1) the APK files in the repo directory, and 2) the metadata files
  22 in the metadata directory.
  23
  24 The metadata files are simple, easy to edit text files, always named as the
  25 application's package ID with '.txt' appended. Within the file, the following
  26 fields are recognised:
  27
  28 ==License==
  29
  30 The license for the application.
  31
  32 Common values: GPLv2, GPLv2+, GPLv3, Apache2, MIT, BSD
  33
  34 ==Name==
  35
  36 The name of the application. Normally, this field should not be present since the
  37 application's correct name is retrieved from the APK file. However, in a situation
  38 where an APK contains a bad or missing application name, it can be overridden
  39 using this.
  40
  41 ==Web Site==
  42
  43 The URL for the application's web site.
  44
  45 ==Source Code==
  46
  47 The URL to view or obtain the application's source code. This should be
  48 something human-friendly. Machine-readable source-code is covered in the
  49 'Repo' field.
  50
  51 ==Issue Tracker==
  52
  53 The URL for the application's issue tracker. Optional, since not all
  54 applications have one.
  55
  56 ==Summary==
  57
  58 A brief summary of what the application is.
  59
  60 ==Description==
  61
  62 A full description of the application. This can span multiple lines, and is
  63 terminated by a line containing a single '.'.
  64
  65 ==Repo Type==
  66
  67 The type of repository - for automatic building from source. If this is not
  68 specified, automatic building is disabled for this application. Possible
  69 values are:
  70
  71   git, svn, hg
  72
  73 ==Repo==
  74
  75 The repository location. Usually a git: or svn: URL.
  76
  77 Normally the repository is checked out once for the application, then moved
  78 to a particular revision/commit/tag for each build version. For an SVN
  79 repository though, this behaviour can be changed by appending a * to the
  80 repository URL - in this case the repository is checked out once per build
  81 version, with the subdir parameter in place of the *. This can be beneficial
  82 when dealing with very large SVN repositories.
  83
  84 ==Build Version==
  85
  86 Any number of these fields can be present, each specifying a version to
  87 automatically build from source. The value is a comma-separated list.
  88 For example:
  89
  90     Build Version:0.12,3,651696a49be2cd7db5ce6a2fa8185e31f9a20035
  91
  92 The above specifies to build version 0.12, which has a version code of 3.
  93 The third parameter specifies the tag, commit or revision number from
  94 which to build it in the source repository.
  95
  96 In addition to the three, always required, parameters described above,
  97 further parameters can be added (in name=value format) to apply further
  98 configuration to the build. These are:
  99
 100  subdir=<path>   - Specifies to build from a subdirectory of the checked out
 101                    source code. Normally this directory is changed to before
 102                    building, but there is a special case for SVN repositories
 103                    where the URL is specified with a * at the end. See the
 104                    documentation for the Repo field for more information.
 105  bindir=<path>   - Normally the build output (apk) is expected to be in the
 106                    bin subdirectory below the ant build files. If the project
 107                    is configured to put it elsewhere, that can be specified
 108                    here, relative to the base of the checked out repo..
 109  oldsdkloc=yes   - The sdk location in the repo is in an old format
 110  target=<target> - Specifies a particular SDK target, when the source doesn't
 111  rm=<relpath>    - Specifies the relative path of file to delete before the
 112                    build is done. The path is relative to the base of the
 113                    build directory - i.e. the directory that contains
 114                    AndroidManifest.xml.
 115
 116 Another example, using extra parameters:
 117
 118     Build Version:1.09.03,10903,45,subdir=Timeriffic,oldsdkloc=yes
 119
 120 ==AntiFeatures==
 121
 122 This is optional - if present, it contains a comma-separated list of any of
 123 the following values, describing an AntiFeature the application has:
 124
 125   "Ads" - the application contains advertising
 126   "Tracking" - the application tracks and reports your activity to somewhere
 127   "NonFreeNet" - the application promotes a non-Free network service
 128   "NonFreeAdd" - the application promotes non-Free add-ons
 129
 130 ==Disabled==
 131
 132 If this field is present, the application does not get put into the public
 133 index. This allows metadata to be retained while an application is temporarily
 134 disabled from being published. The value should be a description of why the
 135 application is disabled.
 136