miracle091/SafeEyes
miracle091
/
SafeEyes
mirror of https://github.com/slgobinath/SafeEyes.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update READ.me

This commit is contained in:
Gobinath 2017-04-21 17:56:25 -04:00
parent ea4857560b
commit bbf10a94e2
16 changed files with 160 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
README.md
View File

@ -1,30 +1,80 @@
Agency Jekyll theme
====================
# Safe Eyes
Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative to EyeLeo; a sexy and customizable alternative to Workrave.
Agency theme based on [Agency bootstrap theme ](http://startbootstrap.com/templates/agency/)
Visit to the official site: http://slgobinath.github.io/SafeEyes/ for more details.
# How to use
## Installation guide
Safe Eyes is available in Ubuntu PPA, Arch AUR and Python PyPI. You can choose any installation source and install on any Linux system with Python 3. To see how to install Safe Eyes, visit [Getting Started](http://slgobinath.github.io/SafeEyes/#introduction)
###Portfolio
## Customizing options
One of the key advantage of Safe Eyes over other similar products is its highly customizable design. You can change almost everything in Safe Eyes. A detailed documentation is available in the official site: [Customize Safe Eyes](http://slgobinath.github.io/SafeEyes/#customize)
Portfolio projects are in '/_posts'
## Contribute
I started this project for my own use and later released it as an open source alternative to EyeLeo and progressively reached to the current state with the great support of open source community. Most of the creative ideas were suggested and implemented by users. You can always add more to Safe Eyes. I have listed some possible ways here: [How to contribute](http://slgobinath.github.io/SafeEyes/#contribute)
Images are in '/img/portfolio'
## Features
###About
General Features:
Images are in '/img/about/'
- Short breaks with eye exercises
- Long breaks to change physical position and to warm up
- Disable the keyboard during break
- Notifications before every break
- Do not disturb when working with full-screen applications( Eg: Watching movies)
- Smart pause and resume based on system idle time (Require `xprintidle`)
- Multi-monitor support
- Multi-language support
- Elegant and customizable design
###Team
Optional Features:
Team members and info are in '_config.yml'
- Strict break for those who are addicted to computer
- Skip or take break based on active windows (Regardless of full-screen-mode)
- Customize individual break time
- Define your own custom exercise
- Audible alert at the end of break
- Turn on/off audible alert for individual breaks
- Customize disable time period
- Lock screen after long breaks
- Plug-in support to extend Safe Eyes
Images are in '/img/team/'
For more details: [SafeEyes Features](http://slgobinath.github.io/SafeEyes/#features)
## Currently available translations
* [Č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)
# Demo
Do you want to see your language here? Please translate Safe Eyes to whatever the languages you know. Visit to **Translate Safe Eyes** in [Customize Safe Eyes](http://slgobinath.github.io/SafeEyes/#customize) to see how to translate.
View this jekyll theme in action [here](https://y7kim.github.io/agency-jekyll-theme)
## Tested Environments
=========
For more details, read [documentation](http://jekyllrb.com/)
Core functionalities of Safe Eyes are tested by the developer in the following environments:
* Antergos 17.4
* Elementary OS Loki
* Fedora 25
* Kubuntu 17.04
* Linux Mint 18.1
* Manjaro 16.10.3
* Ubuntu 14.04
* Ubuntu 16.04
* Ubuntu 16.10
* Ubuntu Budgie 17.04
* Ubuntu Mate 16.04
* Xubuntu 16.10
## License
GNU General Public License v3

4
_includes/services.html
View File

@ -4,7 +4,7 @@
<div class="row">
<div class="col-lg-12 text-center">
<h2 class="section-heading">Getting Started</h2>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative for EyeLeo.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative to EyeLeo; a sexy and customizable alternative to Workrave.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
</div>
</div>
<div class="row text-center">
@ -104,4 +104,4 @@
</div> -->
</div>
</div>
</section>
</section>

3
_site/2014/07/08/project-11/index.html
View File

@ -106,7 +106,7 @@
<div class="row">
<div class="col-lg-12 text-center">
<h2 class="section-heading">Getting Started</h2>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative for EyeLeo.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative to EyeLeo; a sexy and customizable alternative to Workrave.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
</div>
</div>
<div class="row text-center">
@ -207,6 +207,7 @@
</div>
</div>
</section>
<!-- About Section -->
<section id="features">
<div class="container">

3
_site/2014/07/09/project-10/index.html
View File

@ -106,7 +106,7 @@
<div class="row">
<div class="col-lg-12 text-center">
<h2 class="section-heading">Getting Started</h2>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative for EyeLeo.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative to EyeLeo; a sexy and customizable alternative to Workrave.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
</div>
</div>
<div class="row text-center">
@ -207,6 +207,7 @@
</div>
</div>
</section>
<!-- About Section -->
<section id="features">
<div class="container">

3
_site/2014/07/10/project-9/index.html
View File

@ -106,7 +106,7 @@
<div class="row">
<div class="col-lg-12 text-center">
<h2 class="section-heading">Getting Started</h2>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative for EyeLeo.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative to EyeLeo; a sexy and customizable alternative to Workrave.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
</div>
</div>
<div class="row text-center">
@ -207,6 +207,7 @@
</div>
</div>
</section>
<!-- About Section -->
<section id="features">
<div class="container">

3
_site/2014/07/11/project-8/index.html
View File

@ -106,7 +106,7 @@
<div class="row">
<div class="col-lg-12 text-center">
<h2 class="section-heading">Getting Started</h2>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative for EyeLeo.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative to EyeLeo; a sexy and customizable alternative to Workrave.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
</div>
</div>
<div class="row text-center">
@ -207,6 +207,7 @@
</div>
</div>
</section>
<!-- About Section -->
<section id="features">
<div class="container">

3
_site/2014/07/12/project-7/index.html
View File

@ -106,7 +106,7 @@
<div class="row">
<div class="col-lg-12 text-center">
<h2 class="section-heading">Getting Started</h2>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative for EyeLeo.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative to EyeLeo; a sexy and customizable alternative to Workrave.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
</div>
</div>
<div class="row text-center">
@ -207,6 +207,7 @@
</div>
</div>
</section>
<!-- About Section -->
<section id="features">
<div class="container">

3
_site/2014/07/13/project-6/index.html
View File

@ -106,7 +106,7 @@
<div class="row">
<div class="col-lg-12 text-center">
<h2 class="section-heading">Getting Started</h2>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative for EyeLeo.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative to EyeLeo; a sexy and customizable alternative to Workrave.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
</div>
</div>
<div class="row text-center">
@ -207,6 +207,7 @@
</div>
</div>
</section>
<!-- About Section -->
<section id="features">
<div class="container">

3
_site/2014/07/14/project-5/index.html
View File

@ -106,7 +106,7 @@
<div class="row">
<div class="col-lg-12 text-center">
<h2 class="section-heading">Getting Started</h2>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative for EyeLeo.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative to EyeLeo; a sexy and customizable alternative to Workrave.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
</div>
</div>
<div class="row text-center">
@ -207,6 +207,7 @@
</div>
</div>
</section>
<!-- About Section -->
<section id="features">
<div class="container">

3
_site/2014/07/15/project-4/index.html
View File

@ -106,7 +106,7 @@
<div class="row">
<div class="col-lg-12 text-center">
<h2 class="section-heading">Getting Started</h2>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative for EyeLeo.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative to EyeLeo; a sexy and customizable alternative to Workrave.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
</div>
</div>
<div class="row text-center">
@ -207,6 +207,7 @@
</div>
</div>
</section>
<!-- About Section -->
<section id="features">
<div class="container">

3
_site/2014/07/16/project-3/index.html
View File

@ -106,7 +106,7 @@
<div class="row">
<div class="col-lg-12 text-center">
<h2 class="section-heading">Getting Started</h2>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative for EyeLeo.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative to EyeLeo; a sexy and customizable alternative to Workrave.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
</div>
</div>
<div class="row text-center">
@ -207,6 +207,7 @@
</div>
</div>
</section>
<!-- About Section -->
<section id="features">
<div class="container">

3
_site/2014/07/17/project-2/index.html
View File

@ -106,7 +106,7 @@
<div class="row">
<div class="col-lg-12 text-center">
<h2 class="section-heading">Getting Started</h2>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative for EyeLeo.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative to EyeLeo; a sexy and customizable alternative to Workrave.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
</div>
</div>
<div class="row text-center">
@ -207,6 +207,7 @@
</div>
</div>
</section>
<!-- About Section -->
<section id="features">
<div class="container">

3
_site/2014/07/18/project-1/index.html
View File

@ -106,7 +106,7 @@
<div class="row">
<div class="col-lg-12 text-center">
<h2 class="section-heading">Getting Started</h2>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative for EyeLeo.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative to EyeLeo; a sexy and customizable alternative to Workrave.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
</div>
</div>
<div class="row text-center">
@ -207,6 +207,7 @@
</div>
</div>
</section>
<!-- About Section -->
<section id="features">
<div class="container">

82
_site/README.md
View File

@ -1,30 +1,80 @@
Agency Jekyll theme
====================
# Safe Eyes
Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative to EyeLeo; a sexy and customizable alternative to Workrave.
Agency theme based on [Agency bootstrap theme ](http://startbootstrap.com/templates/agency/)
Visit to the official site: http://slgobinath.github.io/SafeEyes/ for more details.
# How to use
## Installation guide
Safe Eyes is available in Ubuntu PPA, Arch AUR and Python PyPI. You can choose any installation source and install on any Linux system with Python 3. To see how to install Safe Eyes, visit [Getting Started](http://slgobinath.github.io/SafeEyes/#introduction)
###Portfolio
## Customizing options
One of the key advantage of Safe Eyes over other similar products is its highly customizable design. You can change almost everything in Safe Eyes. A detailed documentation is available in the official site: [Customize Safe Eyes](http://slgobinath.github.io/SafeEyes/#customize)
Portfolio projects are in '/_posts'
## Contribute
I started this project for my own use and later released it as an open source alternative to EyeLeo and progressively reached to the current state with the great support of open source community. Most of the creative ideas were suggested and implemented by users. You can always add more to Safe Eyes. I have listed some possible ways here: [How to contribute](http://slgobinath.github.io/SafeEyes/#contribute)
Images are in '/img/portfolio'
## Features
###About
General Features:
Images are in '/img/about/'
- Short breaks with eye exercises
- Long breaks to change physical position and to warm up
- Disable the keyboard during break
- Notifications before every break
- Do not disturb when working with full-screen applications( Eg: Watching movies)
- Smart pause and resume based on system idle time (Require `xprintidle`)
- Multi-monitor support
- Multi-language support
- Elegant and customizable design
###Team
Optional Features:
Team members and info are in '_config.yml'
- Strict break for those who are addicted to computer
- Skip or take break based on active windows (Regardless of full-screen-mode)
- Customize individual break time
- Define your own custom exercise
- Audible alert at the end of break
- Turn on/off audible alert for individual breaks
- Customize disable time period
- Lock screen after long breaks
- Plug-in support to extend Safe Eyes
Images are in '/img/team/'
For more details: [SafeEyes Features](http://slgobinath.github.io/SafeEyes/#features)
## Currently available translations
* [Č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)
# Demo
Do you want to see your language here? Please translate Safe Eyes to whatever the languages you know. Visit to **Translate Safe Eyes** in [Customize Safe Eyes](http://slgobinath.github.io/SafeEyes/#customize) to see how to translate.
View this jekyll theme in action [here](https://y7kim.github.io/agency-jekyll-theme)
## Tested Environments
=========
For more details, read [documentation](http://jekyllrb.com/)
Core functionalities of Safe Eyes are tested by the developer in the following environments:
* Antergos 17.4
* Elementary OS Loki
* Fedora 25
* Kubuntu 17.04
* Linux Mint 18.1
* Manjaro 16.10.3
* Ubuntu 14.04
* Ubuntu 16.04
* Ubuntu 16.10
* Ubuntu Budgie 17.04
* Ubuntu Mate 16.04
* Xubuntu 16.10
## License
GNU General Public License v3

4
_site/feed.xml
View File

@ -5,8 +5,8 @@
<description>Protect your eyes from asthenopia</description>
<link>http://localhost:4000/SafeEyes/</link>
<atom:link href="http://localhost:4000/SafeEyes/feed.xml" rel="self" type="application/rss+xml" />
<pubDate>Thu, 20 Apr 2017 11:46:10 -0400</pubDate>
<lastBuildDate>Thu, 20 Apr 2017 11:46:10 -0400</lastBuildDate>
<pubDate>Fri, 21 Apr 2017 17:55:01 -0400</pubDate>
<lastBuildDate>Fri, 21 Apr 2017 17:55:01 -0400</lastBuildDate>
<generator>Jekyll v3.4.0</generator>
<item>

3
_site/index.html
View File

@ -106,7 +106,7 @@
<div class="row">
<div class="col-lg-12 text-center">
<h2 class="section-heading">Getting Started</h2>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative for EyeLeo.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
<h3 class="section-subheading text-muted">Protect your eyes from eye strain using this continuous breaks reminder. A Free and Open Source Linux alternative to EyeLeo; a sexy and customizable alternative to Workrave.<br><br><b>Note: </b>Wayland users must use <code>env GDK_BACKEND=x11 safeeyes</code> instead of <code>safeeyes</code> to start Safe Eyes from terminal.</h3>
</div>
</div>
<div class="row text-center">
@ -207,6 +207,7 @@
</div>
</div>
</section>
<!-- About Section -->
<section id="features">
<div class="container">