Skip to content

Commit 9ed11ef

Browse files
committed
update README
1 parent 4174a54 commit 9ed11ef

File tree

4 files changed

+9
-49
lines changed

4 files changed

+9
-49
lines changed

README.md

Lines changed: 9 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -20,64 +20,24 @@ whereas those utilities vary the colour tone of the display.
2020

2121
1. An icon will appear in your tray when it is running.
2222
2. Click on the icon to launch the console window.
23-
3. Go into "Edit Configuration" and set:
23+
3. Use the menus to set:
2424
- Daytime and Nighttime brightness percentages.
2525
- Transition time (the time it takes to switch between the two brightness values at either sunset or sunrise).
26-
- Your location (either manually enter coordinates, or use "Find Location" to search online).
26+
- Your location (either manually enter coordinates, or using the search tool).
2727
4. Click save and this configuration will be applied and persisted to disk.
28-
5. You can close the console, and it will continue to update your brightness in the background.
28+
5. You can close the window, and it will continue to update your brightness in the background.
2929

30-
(Note there are some more advanced options available via the CLI interface,
31-
try calling `solar_screen_brightness --help`)
30+
### How to Install
3231

33-
### Installation
32+
For Windows, you can download pre-compiled binaries from
33+
[Releases](https://github.com/jacob-pro/solar-screen-brightness/releases).
3434

35-
Pre compiled binaries available in [Releases](https://github.com/jacob-pro/solar-screen-brightness/releases).
36-
37-
Steps for compiling yourself are [below](#compilation).
38-
39-
**NOTE:** If you are on Linux please read the [Linux Guide](docs/LINUX_GUIDE.md).
40-
41-
### Planned Features
42-
43-
- [ ] Per monitor/device brightness settings.
44-
- [ ] macOS Support.
35+
If you are using Linux, please read the [Linux Guide](docs/LINUX_GUIDE.md)
4536

4637
## Screenshots
4738

48-
![](./screenshots/main.png)
49-
5039
![](./screenshots/status.png)
5140

52-
![](./screenshots/edit_config.png)
53-
54-
## Compilation
55-
56-
### Prerequisites
57-
58-
- Install rust using [rustup](https://rustup.rs/) (ensure you have version 1.56 or newer when on Linux)
59-
60-
#### Windows
61-
62-
- Download and install [CMake](https://cmake.org/download/)
63-
- Download and install Visual Studio with the C++ Build Tools.
64-
65-
#### Ubuntu
66-
67-
```
68-
sudo apt update
69-
sudo apt install -y cmake gcc qtbase5-dev libudev-dev
70-
```
71-
72-
#### RHEL/CentOS/Oracle
73-
74-
```
75-
sudo yum install -y cmake gcc qt5-qtbase-devel libudev-devel
76-
sudo ln -s /usr/bin/qmake-qt5 /usr/bin/qmake
77-
```
78-
79-
### Installation
41+
![](./screenshots/brightness.png)
8042

81-
```
82-
cd installer && cargo run --release -- install
83-
```
43+
![](./screenshots/location.png)

screenshots/brightness.png

34.2 KB
Loading

screenshots/location.png

29.2 KB
Loading

screenshots/status.png

41.7 KB
Loading

0 commit comments

Comments
 (0)