summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChandler Justice <chandler@cock.li>2023-12-11 20:36:30 -0700
committerChandler Justice <chandler@cock.li>2023-12-11 20:36:30 -0700
commitc8f2a2635ec90499bd2ec75969f222f398c1bbc5 (patch)
tree9fa7aef82b2fe2ad0f457acc7c821f14c1eef7d1 /README.md
parent871d4b7b8d471e05794dd4c1128d7c2d91d48d56 (diff)
refactor complete
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 20 insertions, 5 deletions
diff --git a/README.md b/README.md
index 557eccd..cf53e7c 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,9 @@ This program will take in an image and generate a color palette based on the ima
## Usage
-`python3 newTheme.py [image]`
+`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
## Requirements
@@ -24,9 +26,22 @@ This program will take in an image and generate a color palette based on the ima
- 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
+ - 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 appropriate 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'`
+ - IE, `alias rice='python3 /home/chandler/Documents/newColors/newTheme.py'`
- reload your bash config/open & close your terminal
- - apply a new theme to your system!
+ - apply a new theme to your system (Ex: `rice -r`)!
+
+ ## Configuration
+
+ Instant Rice stores the locations of your configuration files alongside other settings in the `paths.py` folder within a python dictionary. Before using the program, verify the directories and settings are configured to your system.
+ below is the default paths directory configured for my system:
+ ```
+ Paths = {
+ 'i3': '/home/chandler/.config/i3/config',
+ 'polybar': '/home/chandler/.config/polybar/config.ini',
+ 'wallpapers': '/home/chandler/Pictures/papes/',
+ 'lockscreen': '/home/chandler/.config/i3/'
+ }
+ ```