diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..9f68e5c --- /dev/null +++ b/README.md | |||
@@ -0,0 +1,43 @@ | |||
1 | # vim-colors-off | ||
2 | |||
3 | *This is very much a work in progress* | ||
4 | |||
5 | For a number of weeks, I ran vim with `syntax off`. It was quite nice, | ||
6 | with only two annoyances: | ||
7 | |||
8 | - Bright white on jet black was a bit off-putting. | ||
9 | - There were cases when I did miss the lack of color, vimdiff for | ||
10 | example. | ||
11 | |||
12 | Therefore, I aimed to find or create a colorscheme to solve these two | ||
13 | issues. | ||
14 | |||
15 | The result is very much based on the [pencil][] colorscheme, which is | ||
16 | surprising because it's a very colorful colorscheme, but: | ||
17 | |||
18 | - It uses a very sane approach to defining and setting colors | ||
19 | - It has nice background and foreground colors | ||
20 | - In the areas where I do want color, I like how it colors things | ||
21 | |||
22 | [pencil]: https://github.com/reedes/vim-colors-pencil | ||
23 | |||
24 | ![Screenshot][screenshot.png] | ||
25 | |||
26 | Not super exciting... | ||
27 | |||
28 | ## Installation | ||
29 | |||
30 | - Use [Vundle][] | ||
31 | - Add "pbrisbin/vim-colors-off" as a plugin | ||
32 | |||
33 | [vundle]: https://github.com/gmarik/Vundle.vim | ||
34 | |||
35 | ## Usage | ||
36 | |||
37 | ``` | ||
38 | :colorscheme off | ||
39 | ``` | ||
40 | |||
41 | Supports both `background=light` and `background=dark`. I use dark, so | ||
42 | that will always be the more tested. | ||
43 | |||