Skip to content

Commit

Permalink
Documentation Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
enochlev committed Sep 14, 2023
1 parent 958cd6b commit 3ee2c5c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,17 @@ The program is structured as a simple GUI that allows you to choose which parts

![App screenshot](screenshot.png)

- The blue square surrounds the `Test` button. This button will cause the lights to flicker. This is useful for identifying which light corresponds to which IP address when you're setting things up.
- **Test Button** - This button will cause the lights to flicker. This is useful for identifying which light corresponds to which IP address when you're setting things up.

- The red square allows you to choose which part of the screen each light should sync with. You can choose from the following options: "Full", "Left Half", "Right Half", "Top Half", "Bottom Half".
- **Red square Radio Buttons** - allows you to choose which part of the screen each light should sync with. You can choose from the following options: "Full", "Left Half", "Right Half", "Top Half", "Bottom Half".

- The `Run` button at the bottom of the app starts the screen syncing process. Once this is clicked, each selected light will start mirroring the colors of its assigned screen area. However, please note that this feature is currently a little buggy. Once the screen syncing process has been started, you won't be able to minimize the app window. We're working on fixing this in future updates!
- **Run** - run button starts the screen color sync.

- **Update Frequency** - time to wait between each sync. Better performance when it set to 0, but it increases CPU/Network usage

- **Color Processing Algorithm** - Choice of algorithm to use to process colors.
- Median - middle color sort by RGB intensity
- LeVibrant - chooses more vibrabt colors. Example, light saber swords in a fight scene. *Significantly Better in my opinion*

## Installation

Expand Down
Binary file modified screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3ee2c5c

Please sign in to comment.