Rewrite the templates

This commit is contained in:
Daniel Martí 2014-01-02 18:54:16 +01:00
parent 9ac53be3a1
commit 3d486e0b82
2 changed files with 81 additions and 107 deletions

View file

@ -1,111 +1,62 @@
## 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
# F-Droid metadata template
#
# See http://f-droid.org/manual for more details
#
# Fields that are commented out are optional
# Disabled: (if an app must vanish from the repo)
# AntiFeatures: (comma-separated) (possible values hard-coded in fdroidserver)
Categories: (comma-separated)
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 "."
Web Site: (web link)
Source Code: (web link)
Issue Tracker: (web link)
# Donate: (web link)
# FlattrID: (number)
# Bitcoin: (bitcoin address)
# Name: (to override the name of the app in the index)
Summary: (one sentence, no more than 30-40 chars)
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.
Description of what the app does. It should be as objective as possible.
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
A blank line means a line break, i.e. the end of a paragraph.
The following extra are examples of items that may be helpful —
Bulleted lists can be used:
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.
* Item 1
* Item 2
Links can be added like this:
[https://github.com/org/project/raw/master/res/raw/changelog.xml Changelog]
Links to other apps too: [[some.other.app]]
.
# Yes is the only possible value
Requires Root:
# Requires Root: Yes (f not having root breaks the app or renders it useless)
## 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
# Repo and Build fields only matter in source-built apps
Repo Type: (git, git-svn, svn, hg or bzr)
Repo: (repo url, don't use auth
# A more recent version i.e. one with a greater version code
Build Version:
# One for each source build
# Build:<version>,<version code>
# commit=<tag/commit/rev>
# [...]
#
# For a complete list of flags, see the manual
## Comments on what to watch for when adding new Build Versions (BVs) go here
# Maintainer Notes:
# Here go the notes to take into account for future updates, builds, etc.
# Will be published in the wiki if present.
# .
# 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:
Auto Update Mode: (see the manual)
Update Check Mode: (see the manual)
Current Version: (current version name)
Current Version Code: (current version code, i.e. number)
# The version at which it became impossible to build because of non-free elements
No Source Since:
# No Source Since: First version to be partially or completely missing upstream

View file

@ -1,20 +1,43 @@
Category:
# F-Droid metadata template
#
# See http://f-droid.org/manual for more details
Categories: (comma-separated)
License:
Web Site:
Source Code:
Issue Tracker:
Summary:
Web Site: (web link)
Source Code: (web link)
Issue Tracker: (web link)
Summary: (one sentence, no more than 30-40 chars)
Description:
Description of what the app does. It should be as objective as possible.
A blank line means a line break, i.e. the end of a paragraph.
Bulleted lists can be used:
* Item 1
* Item 2
Links can be added like this:
[https://github.com/org/project/raw/master/res/raw/changelog.xml Changelog]
Links to other apps too: [[some.other.app]]
.
Repo Type:
Repo:
Repo Type: (git, git-svn, svn, hg or bzr)
Repo: (repo url, don't use auth
Build Version:
# One for each source build
# Build:<version>,<version code>
# commit=<tag/commit/rev>
# [...]
#
# For a complete list of flags, see the manual
Auto Update Mode:
Update Check Mode:
Current Version:
Current Version Code:
Auto Update Mode: (see the manual)
Update Check Mode: (see the manual)
Current Version: (current version name)
Current Version Code: (current version code, i.e. number)