160 lines
6.4 KiB
Markdown
160 lines
6.4 KiB
Markdown
> [!IMPORTANT]
|
|
> This app is under heavy development currently.
|
|
|
|
<div align="center">
|
|
|
|
# WeekFocus
|
|
|
|
**One word. One week. One quality to grow.**
|
|
|
|
<a href="https://apps.obtainium.imranr.dev/redirect?r=obtainium://app/%7B%22id%22%3A%22de.schanbro.weekfocus%22%2C%22url%22%3A%22https%3A%2F%2Fgit.schamagusa.de%2FSchanbro%2FWeekFocus%22%2C%22author%22%3A%22Schanbro%22%2C%22name%22%3A%22WeekFocus%22%2C%22overrideSource%22%3A%22Codeberg%22%7D">
|
|
<img src="https://raw.githubusercontent.com/ImranR98/Obtainium/main/assets/graphics/badge_obtainium.png" alt="Get it on Obtainium" height="64">
|
|
</a>
|
|
|
|
[](https://git.schamagusa.de/Schanbro/WeekFocus/releases)
|
|
[](LICENSE)
|
|
<!--[](https://weblate.schamagusa.de/engage/weekfocus/)-->
|
|
|
|

|
|

|
|

|
|

|
|
|
|
<!--[](https://git.schamagusa.de/Schanbro/WeekFocus)
|
|
[](https://git.schamagusa.de/Schanbro/WeekFocus)-->
|
|
[](https://git.schamagusa.de/Schanbro/WeekFocus/issues)
|
|
[](https://git.schamagusa.de/Schanbro/WeekFocus)
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
## Table of Contents
|
|
|
|
- [About](#about)
|
|
- [How It Works](#how-it-works)
|
|
- [Features](#features)
|
|
- [Installation](#installation)
|
|
- [Building from Source](#building-from-source)
|
|
- [Releases](#releases)
|
|
- [Contributing](#contributing)
|
|
- [License](#license)
|
|
- [Translations](#translations)
|
|
|
|
## About
|
|
|
|
WeekFocus is a minimalist Android app built around a simple idea: personal growth works best in small, focused steps.
|
|
|
|
Each week, a single positive quality, such as *patience*, *gratitude* or *courage*, is displayed as one word on a home screen widget. Throughout the week, you consciously focus on living that quality. When the week ends, a new one takes its place.
|
|
|
|
No streaks, no pressure, no clutter. Just a gentle daily reminder of what you want to cultivate.
|
|
|
|
## How It Works
|
|
|
|
1. **Add the widget** to your home screen.
|
|
2. **See your quality of the week** every time you unlock your phone.
|
|
3. **Focus on it** in your daily life for seven days.
|
|
4. **Next week**, a new quality appears and the cycle continues.
|
|
|
|
## Features
|
|
|
|
- Home screen widget showing your current quality of the week
|
|
- Automatic weekly rotation to a new quality
|
|
- Light and dark theme support, Material You
|
|
- No ads, no tracking, no unnecessary permissions
|
|
- Lightweight and battery-friendly
|
|
|
|
## Installation
|
|
|
|
### Recommended: Obtainium
|
|
|
|
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.
|
|
3. Confirm and install the app.
|
|
|
|
Alternatively, tap **Add App** in Obtainium and paste this URL:
|
|
|
|
```
|
|
https://git.schamagusa.de/Schanbro/WeekFocus
|
|
```
|
|
|
|
### Manual APK Install
|
|
|
|
1. Open the [Releases](https://git.schamagusa.de/Schanbro/WeekFocus/releases) page.
|
|
2. Download the latest `.apk` file.
|
|
3. If prompted, allow installation from unknown sources, then install the APK.
|
|
|
|
## Building from Source
|
|
|
|
**Requirements**
|
|
|
|
- [Android Studio](https://developer.android.com/studio) (latest stable)
|
|
- JDK 17 or newer
|
|
- Android SDK platform 37 (`minSdk` 29, `targetSdk` 37)
|
|
|
|
**Steps**
|
|
|
|
```bash
|
|
git clone https://git.schamagusa.de/Schanbro/WeekFocus.git
|
|
cd WeekFocus
|
|
./gradlew assembleDebug
|
|
```
|
|
|
|
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] - 2026-10-03
|
|
|
|
- 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!
|
|
|
|
1. Fork the repository
|
|
2. Create a feature branch: `git checkout -b feature/my-feature`
|
|
3. Commit your changes: `git commit -m "Describe your change"`
|
|
4. Push the branch: `git push origin feature/my-feature`
|
|
5. Open a merge request
|
|
|
|
Found a bug or have an idea? Please open an [issue](https://git.schamagusa.de/Schanbro/WeekFocus/issues).
|
|
|
|
## License
|
|
|
|
This project is licensed under the [GNU General Public License v3.0](LICENSE) (GPL-3.0).
|
|
|
|
You are free to use, modify and redistribute this software under the terms of the GPLv3. Derivative works must be released under the same license.
|
|
|
|
## Translations
|
|
|
|
~~WeekFocus is translated via [Weblate](https://weblate.schamagusa.de/engage/weekfocus/).
|
|
Help translate the app into your language!~~
|
|
<!--[](https://weblate.schamagusa.de/engage/weekfocus/)-->
|
|
|
|
If you want to contribute with translation you would have to fork this repository, translate into the files directly and make an pull request back to this repository.
|