Files
WeekFocus/README.md
T

129 lines
4.5 KiB
Markdown

<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>
![Platform](https://img.shields.io/badge/Platform-Android-3DDC84?logo=android&logoColor=white)
[![Release](https://img.shields.io/gitea/v/release/Schanbro/WeekFocus?gitea_url=https://git.schamagusa.de&label=Release)](https://git.schamagusa.de/Schanbro/WeekFocus/releases)
[![License: GPL-3.0](https://img.shields.io/badge/License-GPL--3.0-blue)](LICENSE)
[![Translation status](https://weblate.schamagusa.de/widgets/weekfocus/-/svg-badge.svg)](https://weblate.schamagusa.de/engage/weekfocus/)
</div>
---
## Table of Contents
- [About](#about)
- [How It Works](#how-it-works)
- [Features](#features)
- [Screenshots](#screenshots)
- [Installation](#installation)
- [Building from Source](#building-from-source)
- [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
- 🔒 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
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)
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
**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/`.
## 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!
[![Translation status](https://weblate.schamagusa.de/widgets/weekfocus/-/multi-auto.svg)](https://weblate.schamagusa.de/engage/weekfocus/)