diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 20 insertions, 5 deletions
@@ -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/' + } + ``` |