diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 28 insertions, 6 deletions
@@ -1,10 +1,19 @@ -# 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 -`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 @@ -17,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/' + } + ``` |