Skip to content

Latest commit

 

History

History
155 lines (116 loc) · 6.96 KB

README.md

File metadata and controls

155 lines (116 loc) · 6.96 KB
Raw

KeepScore

Author

Nolan Lawson

License

WTFPL, although attribution would be nice.

Overview

Screenshot

KeepScore is a free and open-source score-keeping app for Android. Pull requests are always welcome. I'll try to incorporate your changes into the app on the Google Play Store as soon as I can.

Download

KeepScore may be downloaded from the Google Play Store.

You can also find a direct APK download link from the KeepScore page on my web site.

More details about KeepScore can also be found in my blog posts.

Build it yourself

KeepScore is built using Maven.

KeepScore has a dependency, AmbilWarna, which is not avilable in Maven. So you'll have to first install it manually:

git clone https://code.google.com/p/yuku-android-util/
cd yuku-android-util/AmbilWarna
zip -r AmbilWarna.zip *.xml *.properties res src
mvn install:install-file -Dfile=AmbilWarna.zip -DgroupId=yuku.ambilwarna -DartifactId=yuku.ambilwarna-apk -Dversion=1.0 -Dpackaging=apklib

Then, to build, install, and run KeepScore on your device, simply cd to the KeepScore/ directory and do:

mvn clean install android:deploy android:run

To run the unit tests, cd to the KeepScoreTest/ directory and do:

mvn clean install

You must have Maven 3.0.3+ installed in order for this to work.

Add a translation

KeepScore is currently localized into English, French, Japanese, Hebrew, Italian, and German. For the benefit of board gamers around the world, though, I'm always happy to get new translations!

French and Japanese

I manage these myself. I'm not a native speaker, though, so if you have corrections to make, please fork these files:

Italian, Hebrew, and German

These translations are only needed when new feature are added. Thanks to those who helped with the 1.3.0 translations!

Adding a new language

New languages are always welcome! Based on the language statistics, it would be nice to have Dutch, Korean, Russian, Portoguese, and Spanish.

All you need to do is add some additional files, fork the project on GitHub, and send me a pull request. And thanks to GitHub file creation, you can do all of this through the web interface!

For instance, if your language is Esperanto (ISO code 'eo'), you would need to create the following files:

KeepScore/res/values-eo/strings.xml           # Main translations
KeepScore/res/values-eo/dimensions.xml        # Modifies width of the time period overlay (e.g. "Yesterday", 
                                              # "The Past Week") for languages with long words, e.g. French
KeepScore/res/raw-eo/version_and_credits.xml  # Page shown in "About KeepScore"
documentation/description-eo.txt              # Play Store description
documentation/donate/description-eo.txt       # Play Store description (Donate version)

(Again, please read the GitHub page on file creation to understand how to do this.)

I maintain the English, French, and Japanese translations myself. So you can look to these translations as an example:

English French Japanese
strings.xml strings.xml strings.xml
dimensions.xml dimensions.xml dimensions.xml
version_and_credits.htm version_and_credits.htm version_and_credits.htm
description-en.txt description-fr.txt description-ja.txt
donate/description-en.txt donate/description-fr.txt donate/description-ja.txt

Note that not all strings in strings.xml need to be translated. If you look at the English strings.xml file, you'll see that I've helpfully marked constant strings with the prefix CONSTANT_. Constants do not need to be translated.

A helpful tool for finding missing translations is the Android Localization Helper.

To ignore constants while using it, you can run:

/path/to/localization/helper/bin/alh.sh /path/to/keepscore/ | grep -v CONSTANT

Please also tell me what name and email address you would like me to use in the "About" section, so I can give you proper credit. Or just fork and modify the file KeepScore/res/raw/translations.htm yourself. Thanks!