summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChandler J <cjustice2000@gmail.com>2024-02-01 21:48:52 -0700
committerChandler J <cjustice2000@gmail.com>2024-02-01 21:48:52 -0700
commit71332c0c34064aa11cb9a446ba876e79536cfc07 (patch)
treefe7a884488617f1bfa64c633b47222fc868b6736 /README.md
parent8b595e705155b11f08cda27e7fa61281896d3c48 (diff)
updated README
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index cf53e7c..450d3cb 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ This program will take in an image and generate a color palette based on the ima
## Usage
-`python3 instant_rice.py [image_path] [-r] [--nolock]`
+`python3 instant_rice.py [image_path] [-r] [-nolock]`
- `-r`: pick a random image from your `Paths['wallpapers']` directory
- `--nolock`: bypass generating an i3 lock screen
@@ -19,6 +19,7 @@ This program will take in an image and generate a color palette based on the ima
- Need Python3 version `> 3.6`
- `numpy`, `cv2`, and `scipy_learn` module
+ - (optinal) install `rich` for pretty print
- `viu` for displaying wallpaper previews
- This program can be easily obtained from the Rust package manager using `cargo install viu`
@@ -45,3 +46,12 @@ This program will take in an image and generate a color palette based on the ima
'lockscreen': '/home/chandler/.config/i3/'
}
```
+
+ ## Things to change / anticipated features
+
+ - Use less dependencies
+ - Specifically, implement `k-means` algorithm from scratch instead of using library.
+ - Additionally, Replace `rich` with escape sequences.
+ - Implement file initializers. Will put the copy over InstantRice config files to appropriate location
+ - Tui to adjust appearance of system (window boarders, titlebars, bar settings, etc)
+ - *Down the line* Rewrite in a better language.