Skip to content

Commit 6ade67e

Browse files
committed
Update README.
1 parent a8b3545 commit 6ade67e

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

README.md

+23-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,19 @@ f.lux indicator applet
22
======================
33
Better lighting for your computer
44

5-
f.lux indicator applet is an indicator applet to control xflux, an application
6-
that makes the color of your computer's display adapt to the time of day, warm
7-
at nights and like sunlight during the day
5+
The f.lux indicator applet `fluxgui` is an indicator applet to control
6+
`xflux`, an application that makes the color of your computer's
7+
display adapt to the time of day, warm at nights and like sunlight
8+
during the day. Reducing blue light exposure in the evening can help
9+
you fall asleep at night. See https://justgetflux.com/research.html
10+
for more details.
11+
12+
This project -- https://github.com/xflux-gui/xflux-gui -- is only
13+
concerned with the `fluxgui` indicator applet program, not with the
14+
underlying `xflux` program the indicator applet controls. The `xflux`
15+
program is responsible for actually changing the color of your
16+
screen. See https://justgetflux.com/linux.html for more information
17+
about `xflux`.
818

919
Install Instructions
1020
--------------------
@@ -37,3 +47,13 @@ License
3747
-------
3848

3949
The f.lux indicator applet is released under the **MIT License**.
50+
51+
Developing
52+
----------
53+
54+
When working on `fluxgui`, you can use
55+
```bash
56+
cd <path to your xflux-gui.git clone>
57+
PYTHONPATH=`pwd`/src:$PYTHONPATH ./fluxgui &
58+
```
59+
to test your local copy of `fluxgui` without installing anything.

0 commit comments

Comments
 (0)