From 49b37c1957ecf42dccb7683d59d058de987759bb Mon Sep 17 00:00:00 2001 From: AhsanSarwar45 Date: Mon, 11 Dec 2023 16:34:27 +0500 Subject: [PATCH] Update README.md --- README.md | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b48a989b..e0f93679 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,11 @@ Its usable, but still WIP, so you might encounter some bugs. [![codecov](https://codecov.io/gh/AhsanSarwar45/clock/branch/master/graph/badge.svg?token=cKxMm8KVev)](https://codecov.io/gh/AhsanSarwar45/clock) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/7dc1e51c1616482baa5392bc0826c50a)](https://app.codacy.com/gh/AhsanSarwar45/clock/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) - +# Table of Content +- [Features](#features) +- [Installation](#installation) +- [Platforms](#platforms) +- [Development](#development) ## Features - Modern and easy to use interface @@ -31,3 +35,37 @@ Its usable, but still WIP, so you might encounter some bugs. ### Appearance - Highly customizable color themes - Highly customizable style themes + +## Installation +- Download the relevant apk from the releases +- Install (make sure to allow install from unknown sources) + +### Important +After installation, it is important to test whether alarms are working properly and reliably on your device, +since some devices have optimizations and settings that prevent background apps from running properly. + +#### Disable Battery Optimization +- Open the app and go to to Settings (gear icon in the top-right corner) > General > Reliability +- Select `Disable Battery Optimization` +- A settings page will open. Find your device, select it, and select allow. If the app is not visible, +make sure to select 'All apps' from the dropdown + +#### Enable Auto Start +- Open the app and go to to Settings (gear icon in the top-right corner) > General > Reliability +- Select `Auto Start`. If nothing happens, the setting might not be available on your device +- In the settings page that opens, enable Auto Start for the app. + +If alarms are still not working properly, visit [https://dontkillmyapp.com/](https://dontkillmyapp.com/), +and try following the guide for your device. + +If nothing works, feel free to open an issue. + +## Platforms +Currently, the app is only available for android. I don't have an apple device to develop for iOS, but feel free +to contribute if you want iOS support. Most of the app should work fine on other platforms. The alarm and timer features +use android-only code so that will need to be ported. + +## Development + +This app is built using flutter. All you need is to follow [this](https://docs.flutter.dev/get-started/install) +guide to install it, and you should be able to start developing it.