diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0730468b..7d861951 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,23 @@ ### Reporting + Before you report something, read the reporting rules [here](https://github.com/SimpleMobileTools/General-Discussion#how-do-i-suggest-an-improvement-ask-a-question-or-report-an-issue) please. ### Contributing as a developer -Some instructions about code style and everything that has to be done to increase the change of your code getting accepted can be found at the [General Discussion](https://github.com/SimpleMobileTools/General-Discussion#contribution-rules-for-developers) section. + +Some instructions about code style and everything that has to be done to increase the change of your code getting accepted can be found at the [General Discussion](https://github.com/SimpleMobileTools/General-Discussion#contribution-rules-for-developers) section. ### Contributing as a non developer + In case you just want to for example improve a translation, you can find the way of doing it [here](https://github.com/SimpleMobileTools/General-Discussion#how-can-i-suggest-an-edit-to-a-file). + +### Contribution guide for edits + +step1: fork the repository +step2: git clone the repository by pressing the Code button, and under HTTPS, copying the github page URL. This should be used in your downloaded IDE, such as VSCode. +you can also use this command in your terminal: + +cd path/to/your/directory + +git clone https://github.com/username/repository.git + +step3: Make your edits and initiate a pull request! diff --git a/README.md b/README.md index a3e584d8..7f73e191 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ # Simple Clock + Logo This clock app has multiple functions related to timing. It can be used as a clock widget or as a alarm clock. It is made to help you regulate your daily life and sleep better. You can also use the stopwatch in this app to count your time when you are running for healthy lifestyle or for any other purpose. This app can also be placed on your home screen for easy navigation. As a clock widget you can enable displaying times from other time zones, or use the simple, but customizable and resizable clock widget. The text color of the clock widget can be customized, as well as the color and the alpha of the background. You can also change the shape of clock widget according to your choice and show it on the home screen. -The alarm contains all the expected features as day selecting, vibration toggling, ringtone selecting, snooze or adding a custom label. Waking up will be a pleasure. It supports as many alarms as you want, so there won't be any more excuses for not waking up and sleep better :) Gradual volume increasing is supported too, enabled by default. A customizable Snooze button is available too, just in case you really had a good reason for using it. The alarm clock provided by this app as simple as it can get. You simply have to add how many times you want and turn them on. During this, you can also take help from a guide built in this alarm clock app to help you navigate through this app to sleep better. You can sleep better so this app can wake you up on the set time without disturbing your lifestyle. This alarm can be placed on the home screen to make it easy for you to access the alarm while you can work on other things on your device. The main goal of keeping the alarm in this clock widget is to help you schedule your time more effectively. +The alarm contains all the expected features as day selecting, vibration toggling, ringtone selecting, snooze or adding a custom label. Waking up will be a pleasure. It supports as many alarms as you want, so there won't be any more excuses for not waking up and sleep better :) Gradual volume increasing is supported too, enabled by default. A customizable Snooze button is available too, just in case you really had a good reason for using it. The alarm clock provided by this app as simple as it can get. You simply have to add how many times you want and turn them on. During this, you can also take help from a guide built in this alarm clock app to help you navigate through this app to sleep better. You can sleep better so this app can wake you up on the set time without disturbing your lifestyle. This alarm can be placed on the home screen to make it easy for you to access the alarm while you can work on other things on your device. The main goal of keeping the alarm in this clock widget is to help you schedule your time more effectively. With the stopwatch you can easily measure a longer period of time, or individual laps. You can sort the laps in a few different ways. It contains optional vibrations on button presses too, just to let you know that the button was pressed in case you cannot look at the device for some reason, or you are in a hurry. This stopwatch can help you getting in shape if you are doing yoga or having a run in the park. You can put the stopwatch on home screen so that you can easily access it and alter it according to your needs without opening the menu and finding it. @@ -40,3 +41,24 @@ https://t.me/SimpleMobileTools App image +# Installation Instructions + +Google Play: Press the "Get it on Google Play" link and press the installion button. If your app doesn't automatically install, make sure that your phone version is 6.0 or newer. + +F-Droid:Press the "Get it on F-Droid" button. Install F-Droid and choose the newest, latest version for best experience: 5.11.2. + +# Troubleshooting + +Alarm not ringing when phone is locked: + +- Go into battery and notifaction settings. +- Make sure that nothing is blocking reminders or killing the app in the background. +- https://dontkillmyapp.com might help to look at if issue continues. +- restart app + +Stopwatch not working when phone is off: + +- set phone to not shut off when timer is running +- go into settings of app and check box for "Prevent phone from sleeping while the app is in the foreground" +- Go into battery and notifaction settings. +- Make sure that nothing is blocking reminders or killing the app in the background.