summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4625f81..b21d2ef 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,20 @@ This program will take in an image and generate a color palette based on the ima
## Usage
-`newTheme.py [image]`
+`python3 newTheme.py [image]`
## Requirements
- Need Python3 version `> 3.6`
- `numpy`, `cv2`, and `scipy_learn` module
+
+ ## Installation
+
+ - Clone this repo to a safe place
+ - Modify this script to adapt to your configuration
+ - With polybar, it is hard to uniquely identify the lines for the colors without knowing the line number, for this reason, the script will look for a specific line number to modify, and depending on your configuration you might have to change these line numbers. I use modified version of the stock config files for `i3` and `polybar`, so if your config is based on the stock config file, no changes *should* be necessary.
+ - Update `paths.py` with the appropiate paths to your config files
+ - In your `.bashrc`, create an alias to the python script
+ - IE, `alias newtheme='python3 /home/chandler/Documents/newColors/newTheme.py'`
+ - reload your bash config/open & close your terminal
+ - apply a new theme to your system!