diff --git a/README.md b/README.md index ef7f302..88dc667 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,21 @@ # Pywal for Sublime -This is a simple script for generating Sublime color schemes. For the best possible experience use it with an adaptive theme (eg. the built-in one or maybe this [this](https://github.com/pradyun/Sublime-Rainbow-Theme)) +This is a simple script for generating Sublime color schemes. For the best possible experience use it with an adaptive theme (eg. the built-in one or maybe [this](https://github.com/pradyun/Sublime-Rainbow-Theme)) I've chosen colors to be assigned more or less at random, but it looks decent. It's actually the first thing I've written in my life that can be at least remotely useful for someone. I hope it's not too bad! +## Usage + +1. Clone/download the repo +2. (Optional) Copy ```pywal_sublime.py``` somewhere in your ```$PATH``` +3. Add the folowing line to ```~/.config/sublime-text-3/Packages/User/Preferences.sublime-settings```: +```"color_scheme": "Packages/User/PyWal.sublime-color-scheme"``` +or choose the "PyWal" Color Scheme in GUI +4. Select an adaptive UI theme +5. Run ```pywal_sublime.py``` whenever you run ```wal``` eg. by using the ```wal -o``` flag +