Skip to content

Commit 590f88c

Browse files
committed
docs: add README and LICENSE
1 parent 39d6863 commit 590f88c

File tree

2 files changed

+63
-0
lines changed

2 files changed

+63
-0
lines changed

LICENSE

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Copyright (c) 2023 Iván Valdés Castillo
2+
3+
Permission is hereby granted, free of charge, to any person obtaining
4+
a copy of this software and associated documentation files (the
5+
"Software"), to deal in the Software without restriction, including
6+
without limitation the rights to use, copy, modify, merge, publish,
7+
distribute, sublicense, and/or sell copies of the Software, and to
8+
permit persons to whom the Software is furnished to do so, subject to
9+
the following conditions:
10+
11+
The above copyright notice and this permission notice shall be
12+
included in all copies or substantial portions of the Software.
13+
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<img src="https://github.com/ivanvc/android-grayscale-toggle/raw/main/app/src/main/ic_launcher-playstore.png"
2+
width="15%" align="right" alt="Logo" style="padding-left: 10px" />
3+
4+
# Android Grayscale Toggle
5+
6+
This is a minimal and straightforward application to toggle the grayscale color
7+
correction setting on Android devices.
8+
9+
If the application doesn't have permission to change system settings, it will
10+
show instructions on how to do it with ADB. Otherwise, launching the app toggles
11+
the setting. This application is helpful with launchers such as Niagara
12+
Launcher, where you can define an action for a home screen button, or with
13+
devices with a designated function physical button, like Unihertz phones.
14+
15+
[Many](https://www.wired.com/story/grayscale-ios-android-smartphone-addiction/)
16+
[articles](https://observer.com/2018/05/grayscale-can-cure-smartphone-addiction/)
17+
[cover](https://www.theverge.com/23637672/grayscale-iphone-android-pixel-samsung-galaxy-how-to)
18+
[why](https://lifehacker.com/change-your-screen-to-grayscale-to-combat-phone-addicti-1795821843)
19+
[having](https://www.vice.com/en/article/xwm38k/grayscale-setting-phone-addiction)
20+
your smartphone screen in grayscale is a good idea. However, sometimes it's
21+
helpful to switch to full color in case you need to open a navigation app, or if
22+
you want to see a picture you got from a message, or if you're showing your
23+
phone screen to another person.
24+
25+
## Installation
26+
27+
Get the APK from the [releases page](https://github.com/ivanvc/android-grayscale-toggle/releases). Then, install it on your phone.
28+
29+
## Granting Permission to the App
30+
31+
1. Ensure you have ADB installed and configured on your machine. Please take a
32+
look at the [official ABD page](https://developer.android.com/tools/adb).
33+
2. Connect your phone to your computer and allow USB debugging.
34+
3. Open a terminal and run:
35+
```sh
36+
adb shell pm grant vc.ivan.grayscaletoggle android.permission.WRITE_SECURE_SETTINGS
37+
```
38+
39+
That's it. Opening the app will toggle the grayscale mode.
40+
41+
## License
42+
43+
See [LICENSE](LICENSE) © [Ivan Valdes](https://github.com/ivanvc/)

0 commit comments

Comments
 (0)