fdroiddata/metadata/template
2013-10-22 20:24:31 +01:00

112 lines
3.8 KiB
Plaintext

## See http://f-droid.org/manual for details
## 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
Disabled:
# Possible values are hard-coded in the F-Droid source code: separate with a ","
AntiFeatures:
# Not hard-coded but look at the pre-existing ones. Separate with a ";"
Category:
# The ''overall'' license: must be compatible with licenses of components
License:
# Only use if different from Source Code
Web Site:
# Should be http(s)://
Source Code:
# Should be http(s)://
Issue Tracker:
# A dedicated web page with donation buttons is preferred
Donate:
# See http://flattr.com
FlattrID:
# Add a comment about how to verify, such as URL for an issue
Bitcoin:
# Scripts will try to put the app's name here. Don't need to edit it
Auto Name:
# Only changes the name in the index. Not generally required
Name:
# Jargon-free description, not longer than 32 characters
Summary:
# Description goes ''under'' this field, terminated by a line with a single "."
Description:
Blank lines indicate a new paragraph and it is preferrable to make a new
line for a new sentence.
It is applicable to what would be the Recommended Version for most people
i.e. the version that's closest to the Current Version (see below) and also
compatible with their device.
The description should be:
* Fairly future proof, unless you intend to keep it updated
* Not be too short
* With a maximum line length of 80 chars, unless the basic MediaWiki markup is used
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.
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.
Status: Last version and/or BETA and/or current version can't be built.
[https://github.com/org/project/raw/master/res/raw/changelog.xml Changelog]
.
# Yes is the only possible value
Requires Root:
## Repo and Build Version only apply to apps with source-built versions
Repo Type:
Repo:
# Versions/Codes of each Build Version must be different from the others
# Any jars or prebuilts should have references, preferably in the README
# 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 && ...,\
target=android-x,\
compilesdk=x,\
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,\
preassemble=task1 task2,\
gradle=[main|flavor],\
bindir=<path>,\
antcommand=xxx
# A more recent version i.e. one with a greater version code
Build Version:
## Comments on what to watch for when adding new Build Versions (BVs) go here
# This field is best used at the discretion of the repo maintainers
Auto Update Mode:
# One of Tags, RepoManifest, Static, Market or None (in that order of preference)
# 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:
# These two values are usually in the AndroidManifest of the current release,
# but may be automatically updated, depending on the value of the previous field
Current Version:
Current Version Code:
# The version at which it became impossible to build because of non-free elements
No Source Since: