diff options
author | Akshay <[email protected]> | 2020-10-31 08:23:47 +0000 |
---|---|---|
committer | Akshay <[email protected]> | 2020-10-31 08:23:47 +0000 |
commit | ecb58dc6812c7ba71ec76e37032a4f43ab58712c (patch) | |
tree | aecbe446a8dc056256ea0c5fa72a33c24b0948a2 | |
parent | fce8e75f58eecb8a6f743d1bcc34fd32421ebcd5 (diff) |
docs
-rw-r--r-- | README.md | 48 | ||||
-rw-r--r-- | readme.md | 13 |
2 files changed, 13 insertions, 48 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index 7b3a077..0000000 --- a/README.md +++ /dev/null | |||
@@ -1,48 +0,0 @@ | |||
1 | # vim-colors-plain | ||
2 | |||
3 | This is a fork of [vim-colors-off][] which is being developed based on my | ||
4 | personal taste. | ||
5 | |||
6 | ![Screenshot](screenshots/plain-dark.png) | ||
7 | ![Screenshot](screenshots/plain-light.png) | ||
8 | |||
9 | ## Motivation | ||
10 | |||
11 | Minimalistic colorscheme which uses bold to highlight keywords and a | ||
12 | distinguished color for constant literals (string, numbers, JSX tags). | ||
13 | |||
14 | ## Installation & Usage | ||
15 | |||
16 | With [vim-plug][] you add this to the `.vimrc`: | ||
17 | |||
18 | ``` | ||
19 | Plug 'andreypopp/vim-colors-plain' | ||
20 | ``` | ||
21 | |||
22 | Then: | ||
23 | |||
24 | ``` | ||
25 | set background=light " Set to dark for a dark variant | ||
26 | colorscheme plain | ||
27 | ``` | ||
28 | |||
29 | ## FAQ | ||
30 | |||
31 | - What terminal emulator is shown on the screenshots? | ||
32 | |||
33 | This is [kitty][]. Fast and highly configurable. | ||
34 | |||
35 | - Is this Vim or Neovim on the screenshots and why? | ||
36 | |||
37 | This is Neovim. | ||
38 | |||
39 | - What font is being used on the screenshots? | ||
40 | |||
41 | [Pragmata Pro][] which is not free but worth the money paid. [Iosevka][] is | ||
42 | another great font I used before which is similar in feel. | ||
43 | |||
44 | [vim-colors-off]: https://github.com/pbrisbin/vim-colors-off | ||
45 | [vim-plug]: https://github.com/junegunn/vim-plug | ||
46 | [kitty]: https://github.com/kovidgoyal/kitty | ||
47 | [Pragmata Pro]: https://www.fsd.it/shop/fonts/pragmatapro/ | ||
48 | [Iosevka]: https://github.com/be5invis/Iosevka | ||
diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..2a29c4c --- /dev/null +++ b/readme.md | |||
@@ -0,0 +1,13 @@ | |||
1 | ![img](https://u.peppe.rs/bt.png) | ||
2 | |||
3 | vim-colors-plain is a duotonic color scheme, the two accents | ||
4 | being cyan and pink by default (configurable). | ||
5 | |||
6 | vim-plug does not support installing plugins from sources | ||
7 | that do not allow shallow clones (such as git.peppe.rs), i | ||
8 | would suggesting installing manually by cloning into your | ||
9 | plugin directory or dropping `colors/plain.vim` into one of | ||
10 | the following directories: | ||
11 | |||
12 | - vim: `.vim/plugin` | ||
13 | - neovim: `.config/nvim/plugin` | ||