SafeEyes/README.md

72 lines
2.9 KiB
Markdown
Raw Normal View History

2016-10-15 06:11:27 +02:00
# Safe Eyes
2016-10-23 14:34:24 +02:00
Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative for EyeLeo.
2016-10-15 06:11:27 +02:00
2017-04-18 17:55:57 +02:00
Visit to the official site: http://slgobinath.github.io/SafeEyes/ for more details.
2017-02-13 18:12:33 +01:00
2017-04-18 17:55:57 +02:00
## [Installation guide](http://slgobinath.github.io/SafeEyes/#introduction)
2016-10-25 17:20:23 +02:00
2017-04-18 17:55:57 +02:00
## [Customizing options](http://slgobinath.github.io/SafeEyes/#customize)
2016-10-23 18:55:08 +02:00
2017-04-18 17:55:57 +02:00
## [Contribute](http://slgobinath.github.io/SafeEyes/#contribute)
2017-04-15 21:13:01 +02:00
2017-04-18 17:55:57 +02:00
## Features
General Features:
2016-10-15 06:11:27 +02:00
- Short breaks with eye exercises
- Long breaks to change physical position and to warm up
2016-10-23 14:34:24 +02:00
- Disable the keyboard during break
2016-10-15 06:11:27 +02:00
- Notifications before every break
2017-04-15 16:34:54 +02:00
- Do not disturb when working with full-screen applications( Eg: Watching movies)
2017-02-06 03:37:10 +01:00
- Smart pause and resume based on system idle time
2016-11-15 14:46:56 +01:00
- Multi-monitor support
2016-10-15 06:11:27 +02:00
- Elegant and customizable design
2016-11-15 14:46:56 +01:00
- Multi-language support
- Highly customizable
Optional Features:
- Strict break for those who are addicted to computer
2017-04-15 16:34:54 +02:00
- Skip or take break based on active windows (Regardless of full-screen-mode)
- Customize individual break time
- Audible alert at the end of break
- Turn on/off audible alert for individual breaks
- Customize disable time period
2017-04-15 16:34:54 +02:00
- Plug-in support to extend Safe Eyes
2016-10-15 06:11:27 +02:00
2017-04-18 17:55:57 +02:00
## Currently available translations
2017-04-03 20:29:21 +02:00
* [Čeština](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/config/lang/cs.json)
* [Deutsch](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/config/lang/de.json)
* [English](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/config/lang/en.json)
* [Español](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/config/lang/es.json)
* [Français](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/config/lang/fr.json)
* [ქართული](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/config/lang/ge.json)
* [हिंदी](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/config/lang/hi.json)
* [Magyar](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/config/lang/hu.json)
* [Bahasa Indonesia](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/config/lang/id.json)
* [Português](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/config/lang/pt.json)
* [Русский](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/config/lang/ru.json)
* [Slovenský](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/config/lang/sk.json)
* [தமிழ்](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/config/lang/ta.json)
* [Türkçe](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/config/lang/tr.json)
2017-01-10 13:32:57 +01:00
2017-04-18 17:55:57 +02:00
## Tested Environments
2017-01-10 13:32:57 +01:00
Core functionalities of Safe Eyes are tested by the developer in the follwing environments:
2017-01-10 13:32:57 +01:00
* Ubuntu 14.04
* Ubuntu 16.04
* Ubuntu 16.10
* Linux Mint 18
2016-10-31 14:57:54 +01:00
* Ubuntu Mate 16.04
2017-02-06 03:17:01 +01:00
* Kubuntu 16.10
2017-04-18 17:55:57 +02:00
* Manjaro
* Elementary OS Loki
* Antergos 2017 (Antergos Gnome users must provide their own lock screen command)
2016-10-15 06:11:27 +02:00
2017-04-18 17:55:57 +02:00
## License
2016-10-15 06:11:27 +02:00
GNU General Public License v3