summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChandler Justice <chandler@cock.li>2023-11-23 10:37:43 -0700
committerChandler Justice <chandler@cock.li>2023-11-23 10:37:43 -0700
commit08c87dc3c1eb33027889c64ee00e4e5ecce82206 (patch)
tree812777decb3d8783e27bad4b00008d0ab40f3637 /README.md
initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4625f81
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# Dynamic Theme Switcher
+
+This program will take in an image and generate a color palette based on the image. This palette will be determined by first doing a KMeans analysis on the image to find the most prominent colors, and then generating a complimentary color for each of the most prominent colors. After determining the colors, the program will automatically update the colors for i3 and Polybar to the new color scheme. Next, the program will update the background displayed to the image passed in and prompt the user to re-load i3.
+
+## Usage
+
+`newTheme.py [image]`
+
+## Requirements
+
+ - Need Python3 version `> 3.6`
+ - `numpy`, `cv2`, and `scipy_learn` module