fdroiddata/metadata/template

112 lines
3.8 KiB
Plaintext
Raw Normal View History

## See http://f-droid.org/manual for details
2013-08-25 18:25:55 +00:00
## Fields and comments which aren't used can be deleted
## Blank lines are customary as they are seen here
#
# Only used for making an app disappear from the index
2013-01-26 14:25:27 +00:00
Disabled:
# Possible values are hard-coded in the F-Droid source code: separate with a ","
2013-01-26 14:25:27 +00:00
AntiFeatures:
# Not hard-coded but look at the pre-existing ones. Separate with a ";"
2011-11-27 10:10:44 +00:00
Category:
# The ''overall'' license: must be compatible with licenses of components
License:
# Only use if different from Source Code
2011-02-24 22:47:19 +00:00
Web Site:
# Should be http(s)://
2011-02-24 22:47:19 +00:00
Source Code:
# Should be http(s)://
2011-02-24 22:47:19 +00:00
Issue Tracker:
# A dedicated web page with donation buttons is preferred
2011-02-24 22:47:19 +00:00
Donate:
2013-08-25 18:25:55 +00:00
# See http://flattr.com
FlattrID:
2013-08-25 18:25:55 +00:00
# Add a comment about how to verify, such as URL for an issue
Bitcoin:
2013-08-25 18:25:55 +00:00
# Scripts will try to put the app's name here. Don't need to edit it
2013-07-20 21:17:11 +00:00
Auto Name:
# Only changes the name in the index. Not generally required
Name:
2013-07-13 18:07:40 +00:00
# Jargon-free description, not longer than 32 characters
Summary:
2013-07-20 21:17:11 +00:00
# Description goes ''under'' this field, terminated by a line with a single "."
2011-02-24 22:47:19 +00:00
Description:
Blank lines indicate a new paragraph and it is preferrable to make a new
line for a new sentence.
2013-07-20 21:17:11 +00:00
It is applicable to what would be the Recommended Version for most people
2013-07-25 11:14:00 +00:00
i.e. the version that's closest to the Current Version (see below) and also
2013-07-20 21:17:11 +00:00
compatible with their device.
2013-07-20 21:17:11 +00:00
The description should be:
* Fairly future proof, unless you intend to keep it updated
* Not be too short
2013-07-20 21:17:11 +00:00
* With a maximum line length of 80 chars, unless the basic MediaWiki markup is used
2013-07-25 11:14:00 +00:00
The following extra are examples of items that may be helpful —
Requires root: No. The app can reboot the phone if it is allowed root.
2013-07-25 11:14:00 +00:00
Anti-features:
* Tracking: The app uploads usage stats — see the Website for details
* Non-free Network Services: Calculations are done on the developers' server
Google Ad library was removed before building.
Supports x86 natively.
2013-07-25 11:14:00 +00:00
Status: Last version and/or BETA and/or current version can't be built.
2013-05-04 19:29:43 +00:00
[https://github.com/org/project/raw/master/res/raw/changelog.xml Changelog]
2011-02-24 22:47:19 +00:00
.
# Yes is the only possible value
Requires Root:
2013-01-26 14:25:27 +00:00
2013-08-25 18:25:55 +00:00
## Repo and Build Version only apply to apps with source-built versions
2011-02-24 22:47:19 +00:00
Repo Type:
Repo:
2013-07-25 11:14:00 +00:00
# Versions/Codes of each Build Version must be different from the others
# Any jars or prebuilts should have references, preferably in the README
2013-07-25 11:14:00 +00:00
# The following contains all possible parameters in the best order
Build Version:version,version code,commit/tag,\
subdir=<path/to/manifest or pom>,\
submodules=yes,\
init=xxxx && yyyy && ...,\
2013-08-25 18:25:55 +00:00
target=android-x,\
compilesdk=x,\
2013-07-25 11:14:00 +00:00
update=[no|force|.;<path/to/x>;<path/to/y>;...],\
encoding=xxxx,\
rm=<relpath/to/x.apk>;<relpath/to/y.jar>;...,\
extlibs=a/Av1.2.jar;b/Bv1.3.jar;...,\
srclibs=a@r;b@r1;...,\
patch=x.patch;...,\
prebuild=xxxx && yyyy && ...,\
build=xxxx && yyyy && ...,\
buildjni=[yes|no|<dir list>],\
maven=yes,\
2013-08-25 18:25:55 +00:00
preassemble=task1 task2,\
gradle=[main|flavor],\
2013-07-25 11:14:00 +00:00
bindir=<path>,\
antcommand=xxx
2013-07-25 11:14:00 +00:00
2013-08-25 18:25:55 +00:00
# A more recent version i.e. one with a greater version code
Build Version:
2011-02-24 22:47:19 +00:00
2013-07-20 21:17:11 +00:00
## Comments on what to watch for when adding new Build Versions (BVs) go here
2013-08-25 18:25:55 +00:00
# This field is best used at the discretion of the repo maintainers
2013-01-26 14:25:27 +00:00
Auto Update Mode:
# One of Tags, RepoManifest, Static, Market or None (in that order of preference)
2013-07-25 11:14:00 +00:00
# If None or Market, describe why the other methods don't work
# Tags and RepoManifest (RM) are automatic but check that the mechanism works
# Use Static if you plan to let the maintainers know in person (so to speak)
Update Check Mode:
2013-07-25 11:14:00 +00:00
# These two values are usually in the AndroidManifest of the current release,
2013-08-25 18:25:55 +00:00
# but may be automatically updated, depending on the value of the previous field
2013-01-26 14:25:27 +00:00
Current Version:
Current Version Code:
2013-07-25 11:14:00 +00:00
# The version at which it became impossible to build because of non-free elements
2013-05-17 18:53:34 +00:00
No Source Since: