Skip to content

Commit

Permalink
- updates readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pablo03v committed Apr 14, 2024
1 parent daf729b commit 905ab57
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 25 deletions.
53 changes: 28 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![Translation status](https://translate.codeberg.org/widget/overload/android/svg-badge.svg)](https://translate.codeberg.org/engage/overload/)
[![Translation status](https://badges.crowdin.net/overload/localized.svg)](https://crowdin.com/project/overload)

# Overload

Expand All @@ -9,18 +9,18 @@ Overload is an Android (8.0+) application which allows you to capture timespans

Contributions are always welcome!

Just create issues and pull requests in the dev-branch or help [translating](https://translate.codeberg.org/engage/overload/) on Weblate :)
Just create issues and pull requests in the dev-branch or help [translating](https://crowdin.com/project/overload) on Crowdin :)


## Features

- create and manage categories with colors, emojis and goals
- create time spans
- automatically creates pauses in between
- delete time spans - on-by-one or all-together
- scroll through days with ease
- backup your data
- import backups
- set goals


## Feedback
Expand All @@ -41,42 +41,50 @@ Feedback and suggestions are more than welcome! Please reach out by creating an

## Authors

- [@pabloscloud](https://codeberg.org/pabloscloud)
- [@pabloscloud](https://github.com/pabloscloud)

### Translators
### Kudos

#### Translators

- [@mondstern](https://codeberg.org/mondstern)
- [@Vistaus](https://codeberg.org/Vistaus)
- [@0que](https://codeberg.org/0que)

#### Projects

This project is forked from the jetpack compose sample [Reply](https://github.com/android/compose-samples/tree/main/Reply), which is licensed under the Apache License, Version 2.0.

I used portions of the code of the lovely material you style RSS reader [ReadYou](https://github.com/Ashinch/ReadYou) for the color picker which is licensed under GNU GPLv3. Thanks for the [allowed use](https://github.com/Ashinch/ReadYou/discussions/687) [(archive.org)](https://web.archive.org/web/20240414115828/https://github.com/Ashinch/ReadYou/discussions/687).


## Screenshots

<table>
<tr>
<td><img src="https://codeberg.org/pabloscloud/Overload/raw/branch/main/screenshots/1.png" alt="Screenshot 1"></td>
<td><img src="https://codeberg.org/pabloscloud/Overload/raw/branch/main/screenshots/2.png" alt="Screenshot 2"></td>
<td><img src="https://codeberg.org/pabloscloud/Overload/raw/branch/main/screenshots/3.png" alt="Screenshot 3"></td>
<td><img src="https://codeberg.org/pabloscloud/Overload/raw/branch/main/screenshots/4.png" alt="Screenshot 4"></td>
<td><img src="https://github.com/pabloscloud/Overload/raw/main/screenshots/1.png" alt="Screenshot 1"></td>
<td><img src="https://github.com/pabloscloud/Overload/raw/main/screenshots/2.png" alt="Screenshot 2"></td>
<td><img src="https://github.com/pabloscloud/Overload/raw/main/screenshots/3.png" alt="Screenshot 3"></td>
<td><img src="https://github.com/pabloscloud/Overload/raw/main/screenshots/4.png" alt="Screenshot 4"></td>
</tr>
<tr>
<td><img src="https://codeberg.org/pabloscloud/Overload/raw/branch/main/screenshots/5.png" alt="Screenshot 1"></td>
<td><img src="https://codeberg.org/pabloscloud/Overload/raw/branch/main/screenshots/6.png" alt="Screenshot 2"></td>
<td><img src="https://codeberg.org/pabloscloud/Overload/raw/branch/main/screenshots/7.png" alt="Screenshot 3"></td>
<td><img src="https://codeberg.org/pabloscloud/Overload/raw/branch/main/screenshots/8.png" alt="Screenshot 4"></td>
<td><img src="https://github.com/pabloscloud/Overload/raw/main/screenshots/5.png" alt="Screenshot 1"></td>
<td><img src="https://github.com/pabloscloud/Overload/raw/main/screenshots/6.png" alt="Screenshot 2"></td>
<td><img src="https://github.com/pabloscloud/Overload/raw/main/screenshots/7.png" alt="Screenshot 3"></td>
<td><img src="https://github.com/pabloscloud/Overload/raw/main/screenshots/8.png" alt="Screenshot 4"></td>
</tr>
<tr>
<td><img src="https://codeberg.org/pabloscloud/Overload/raw/branch/main/screenshots/9.png" alt="Screenshot 1"></td>
<td><img src="https://codeberg.org/pabloscloud/Overload/raw/branch/main/screenshots/10.png" alt="Screenshot 2"></td>
<td><img src="https://codeberg.org/pabloscloud/Overload/raw/branch/main/screenshots/11.png" alt="Screenshot 3"></td>
<td><img src="https://codeberg.org/pabloscloud/Overload/raw/branch/main/screenshots/12.png" alt="Screenshot 4"></td>
<td><img src="https://github.com/pabloscloud/Overload/raw/main/screenshots/9.png" alt="Screenshot 1"></td>
<td><img src="https://github.com/pabloscloud/Overload/raw/main/screenshots/10.png" alt="Screenshot 2"></td>
<td><img src="https://github.com/pabloscloud/Overload/raw/main/screenshots/11.png" alt="Screenshot 3"></td>
<td><img src="https://github.com/pabloscloud/Overload/raw/main/screenshots/12.png" alt="Screenshot 4"></td>
</tr>
</table>


## FAQ

### How do I import a backup? {#import-backup}
### How do I import a backup?
Open your files app, choose the backup file, and locate the share icon or text. Tapping this icon will bring up a menu displaying various apps for sharing. From the list, select Overload to initiate the import. Wait until the import is finished, indicated by a completion message.

### Why does Overload rely on the Systems Sharesheet to import a backup?
Expand All @@ -86,14 +94,9 @@ Overload utilises the Systems Sharesheet for importing backups instead of reques
### What are ongoing pauses?
By showing the duration between the last item and the current time you can determine how long you stopped or paused working since then. You can plan how much longer your pause is at any given moment as the duration updates in real time.

### Why can't I delete an ongoing pause? {#delete-pause}
### Why can't I delete an ongoing pause?
You cannot delete ongoing pauses as they are only there to indicate a pause will be created once you hit start again. If you will not hit start until the next day it will be gone and will not count against your goal. By deleting items that occurred beforehand, you can hide the pause.
Imagine you're using the app to track your work hours. You take a break, and an ongoing pause is created. If you get ill during the day or decide not to work on the day for any other reason, the ongoing pause will vanish without affecting your work-time goal.

### Why does the app annoy me with a popup to adjust the end? {#spread-across-days}
### Why does the app annoy me with a popup to adjust the end?
Sometimes we forget stuff. Sometimes we do stuff across days - like sleeping. Nevertheless when an item is still ongoing from yesterday or days before yesterday, you need to set an end or confirm you want to spread the item across multiple days. The popup will be gone once there are no more ongoing items from the past days ;)


## Related

This project draws inspiration from the jetpack compose sample [Reply](https://github.com/android/compose-samples/tree/main/Reply), which is licensed under the Apache License, Version 2.0.
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
/*
* This portion of code is derived from the Read You app, which is licensed under GNU GPLv3.
* Original copyright (c) 2022 Ashinch.
*
* The portions of code are used under the terms of the GNU GPLv3 license.
* See https://www.gnu.org/licenses/gpl-3.0.html for more details.
*
* Modifications:
* - colors
* - size
* - layout
* - content
*/

package cloud.pablos.overload.ui.tabs.configurations

import androidx.compose.animation.Animatable
Expand Down

0 comments on commit 905ab57

Please sign in to comment.