forked from Schanbro/WeekFocus
README.md aktualisiert
This commit is contained in:
1 parent
2ab1b230d8
commit
f5568cf211
1 file changed
+32
-14
@@ -15,7 +15,7 @@
|
||||
[](LICENSE)
|
||||
[](https://weblate.schamagusa.de/engage/weekfocus/)
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
@@ -35,9 +35,9 @@
|
||||
- [About](#about)
|
||||
- [How It Works](#how-it-works)
|
||||
- [Features](#features)
|
||||
- [Screenshots](#screenshots)
|
||||
- [Installation](#installation)
|
||||
- [Building from Source](#building-from-source)
|
||||
- [Releases](#releases)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
- [Translations](#translations)
|
||||
@@ -65,16 +65,6 @@ No streaks, no pressure, no clutter. Just a gentle daily reminder of what you wa
|
||||
- 🔒 No ads, no tracking, no unnecessary permissions
|
||||
- ⚡ Lightweight and battery-friendly
|
||||
|
||||
## Screenshots
|
||||
|
||||
<!-- Add screenshots here, for example:
|
||||
<p align="center">
|
||||
<img src="docs/screenshots/1.png" width="24%" />
|
||||
<img src="docs/screenshots/2.png" width="24%" />
|
||||
<img src="docs/screenshots/3.png" width="24%" />
|
||||
</p>
|
||||
-->
|
||||
|
||||
## Installation
|
||||
|
||||
### Recommended: Obtainium
|
||||
@@ -82,8 +72,7 @@ No streaks, no pressure, no clutter. Just a gentle daily reminder of what you wa
|
||||
With [Obtainium](https://github.com/ImranR98/Obtainium) you get updates directly from this repository, no app store required.
|
||||
|
||||
1. Install Obtainium on your Android device.
|
||||
2. Tap the badge above or open this link:
|
||||
[Add WeekFocus to Obtainium](https://apps.obtainium.imranr.dev/redirect?r=obtainium://add/https://git.schamagusa.de/Schanbro/WeekFocus)
|
||||
2. Tap the badge above.
|
||||
3. Confirm and install the app.
|
||||
|
||||
Alternatively, tap **Add App** in Obtainium and paste this URL:
|
||||
@@ -104,6 +93,7 @@ https://git.schamagusa.de/Schanbro/WeekFocus
|
||||
|
||||
- [Android Studio](https://developer.android.com/studio) (latest stable)
|
||||
- JDK 17 or newer
|
||||
- Android SDK platform 37 (`minSdk` 29, `targetSdk` 37)
|
||||
|
||||
**Steps**
|
||||
|
||||
@@ -115,6 +105,34 @@ cd WeekFocus
|
||||
|
||||
The resulting APK is located in `app/build/outputs/apk/debug/`.
|
||||
|
||||
## Releases
|
||||
|
||||
Releases are built automatically with Gitea Actions. Pushing a tag that starts with `v` triggers the workflow, which builds and signs the APK and publishes it as a release together with the notes from `CHANGELOG.md`.
|
||||
|
||||
### Starting a release build
|
||||
|
||||
Create a tag and push it. The tag name determines the app version (`v1.1.3` builds version `1.1.3`):
|
||||
|
||||
```bash
|
||||
git tag v1.1.3
|
||||
git push origin v1.1.3
|
||||
```
|
||||
|
||||
You can follow the build under **Actions** in the repository. When it finishes, the signed `WeekFocus-1.1.3.apk` appears on the [Releases](https://git.schamagusa.de/Schanbro/WeekFocus/releases) page.
|
||||
|
||||
### Release notes
|
||||
|
||||
The workflow takes the notes from the section of `CHANGELOG.md` whose heading starts with the version number:
|
||||
|
||||
```markdown
|
||||
## 1.1.3
|
||||
|
||||
- Added Weblate translations
|
||||
- Fixed widget update at the start of a new week
|
||||
```
|
||||
|
||||
If no matching section exists, the release gets a short placeholder text instead.
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome!
|
||||
|
||||
Reference in new issue
Block a user