diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 74 |
1 files changed, 74 insertions, 0 deletions
| @@ -1,3 +1,77 @@ | |||
| 1 | # scorecounter | 1 | # scorecounter |
| 2 | 2 | ||
| 3 | *scorecounter* is a simple score counting app written in Python. | 3 | *scorecounter* is a simple score counting app written in Python. |
| 4 | |||
| 5 | |||
| 6 | ## General | ||
| 7 | |||
| 8 | *scorecounter* is intended for use on mobile devices (mobile phones and tablets) | ||
| 9 | as a simple app for counting and recording scores during head‑to‑head games | ||
| 10 | between two teams or participants. It is perfect for parents who want to | ||
| 11 | record a child's football match score. | ||
| 12 | No ads, no tracking, 100% free (as in freedom) software that doesn't require | ||
| 13 | network access or additional permissions. | ||
| 14 | |||
| 15 | Hence the intended target systems are *Android* and *iOS*, but because the | ||
| 16 | application is implemented with [BeeWare](https://beeware.org/) it can be | ||
| 17 | deployed to any platform supported by BeeWare. | ||
| 18 | |||
| 19 | To date, only the Android build has been tested and documented. | ||
| 20 | |||
| 21 | |||
| 22 | ## How to use | ||
| 23 | |||
| 24 | When a team or participant scores, tap their corresponding red or blue button. | ||
| 25 | You can assign custom names to teams or participants. | ||
| 26 | |||
| 27 | |||
| 28 | ## Building and installing | ||
| 29 | |||
| 30 | This document assumes that [Briefcase](https://briefcase.beeware.org/en/stable/) | ||
| 31 | is installed. | ||
| 32 | |||
| 33 | For more details visit the [official BeeWare tutorial](https://tutorial.beeware.org/) | ||
| 34 | |||
| 35 | iOS applications require Xcode, which is only available on macOS | ||
| 36 | - a proprietary operating system I do not intend to use. | ||
| 37 | |||
| 38 | |||
| 39 | ### Android | ||
| 40 | |||
| 41 | ```bash | ||
| 42 | # build scorecounter for Android | ||
| 43 | briefcase build android | ||
| 44 | |||
| 45 | # Run and test scorecounter either using emulator or a real phone | ||
| 46 | # connected using an USB cable | ||
| 47 | briefcase run android | ||
| 48 | |||
| 49 | # Make .apk package | ||
| 50 | briefcase package android -p apk | ||
| 51 | ``` | ||
| 52 | |||
| 53 | |||
| 54 | ## Changelog | ||
| 55 | |||
| 56 | A complete changelog can be found at: | ||
| 57 | [https://codeberg.org/sgs/scorecounter/src/branch/main/CHANGELOG.md](https://codeberg.org/sgs/scorecounter/src/branch/main/CHANGELOG.md) | ||
| 58 | |||
| 59 | |||
| 60 | ## Support and contributing | ||
| 61 | |||
| 62 | *scorecounter* is hosted on Codeberg: https://codeberg.org/sgs/scorecounter | ||
| 63 | |||
| 64 | |||
| 65 | ## Author | ||
| 66 | |||
| 67 | Simeon Simeonov - sgs @ LiberaChat | ||
| 68 | |||
| 69 | |||
| 70 | ## [License](https://codeberg.org/sgs/scorecounter/src/branch/main/LICENSE) | ||
| 71 | |||
| 72 | Copyright (C) 2026 Simeon Simeonov | ||
| 73 | All rights reserved. | ||
| 74 | |||
| 75 | [Licensed](https://codeberg.org/sgs/scorecounter/src/branch/main/LICENSE) under the | ||
| 76 | GNU General Public License v3.0 or later. | ||
| 77 | SPDX-License-Identifier: GPL-3.0-or-later | ||
