Add usage info to README.md

This commit is contained in:
Brychlikov 2019-03-24 19:04:36 +01:00 committed by GitHub
parent e4093b211d
commit d40eefcf01
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,11 +1,21 @@
# Pywal for Sublime # 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. 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! 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