SafeEyes/README.md

54 lines
1.6 KiB
Markdown
Raw Normal View History

2016-10-15 06:11:27 +02:00
# Safe Eyes
Protect your eyes from eye strain using this continous breaks reminder. A Free and Open Source Linux alternative for EyeLeo.
## Installation
1: Add the PPA: `sudo add-apt-repository ppa:slgobinath/safeeyes`
2: Download the package list: `sudo apt update`
3: Install uget-chrome-wrapper: `sudo apt install safeeyes`
4: Start Safe Eyes from start menu.
## Usage
Just install and forget; Safe Eyes will take care of your eyes. To customize the preferences, go to Settings from Safe Eyes tray icon.
For advanced configuration, go to `~/.config/safeeyes folder`. There you can change the Skip button text in `safeeyes.json` and the look and feel of the break screen in `style/safeeyes_style.css`.
## Features
- Short breaks with eye exercises
- Long breaks to change physical position and to warm up
- Strict break for those who are addicted to computer
- Highly customizable
- Do not disturb when working with fullscreen applications( Eg: Watching movies)
- Notifications before every break
- Multi-workspace support
- Elegant and customizable design
## Contributing
**Are you a user?**
Please test Safe Eyes on your system and report any issues [here](https://github.com/slgobinath/SafeEyes/issues)
**Are you a developer?**
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request
**Are you using a different Linux system?**
Please test Safe Eyes and create installers for your operating system
## History
Version 1.0.0:
* Intial release
## License
GNU General Public License v3