words.hk

• The app complies with the inclusion criteria.
• The app is not already listed in the repo or issue tracker.
• The app has not already been requested
• The upstream app source code repo contains the app metadata (summary/description/images/changelog/etc) in a Fastlane or Triple-T folder structure
• The original app author has been notified, and does not oppose the inclusion.
• Donated to support the maintenance of this app in F-Droid.

---

The first step is to find the app's Application ID. This is usually the same as the app's Package Name. You will find it in files called AndroidManifest.xml or build.gradle most of the time. You can also see it in the URLs for the app's page in various app stores. Write it here:

APPLICATION ID: hk.words.wordshk

Below is a template "metadata file" to fill out, it has only the required fields. F-Droid uses this file to build and publish the app. Build Metadata Reference documents all available options. Add values after the colon

# Categories (one per line, each starting with a space and a minus), chosen from the
# official list: https://gitlab.com/fdroid/fdroiddata/blob/master/stats/categories.txt
Categories:
 - Science & Education

# the one license that the whole app is available under, use
# https://spdx.org/licenses/ short identifiers, must be
# floss-compatible.
License: MIT

# You can provide details on how to contact the author. These are optional, but
# nice to have.
AuthorName: Xiang (Kevin) Li
AuthorEmail: 
AuthorWebSite: 

# A URL for the project's website, and to the source code repository to visit
# using a web browser. WebSite is optional.
WebSite: https://words.hk
SourceCode: https://github.com/AlienKevin/wordshk_app

# A link to the issue tracker where bugs are reported
IssueTracker: 

# If available, you can also provide links/IDs for donations.
Donate: 
Bitcoin: 
LiberaPay: 

# Name of the application
AutoName: 

# One sentence, no more than 30-50 chars, no trailing punctuation,
# focus on actions what the users does with the app, e.g. "Read and
# send emails" instead of "Email client".
# NOTE: Summary and Description are preferably provided via Fastlane or Triple-T!
Summary: An open Cantonese dictionary for users with various backgrounds
Description: |-
    Words.hk is an open Cantonese dictionary for users with various backgrounds: whether you are a Cantonese beginner or native speaker.

    Features:
    1. Search in English, Cantonese, or various romanizations like Jyutping and Yale
    2. Handwritting recognition of Chinese characters in searches
    3. Cantonese dictation in searches
    4. Listen to pronunciations for words and example sentences
    5. Bilingual dictionary contents in both English and Cantonese

# Repository details to be used by VCS (Version Control Systems)
# git, git-svn, svn, hg or bzr
RepoType: git

# source code repo URL (HTTPS required)
Repo: https://github.com/AlienKevin/wordshk_app