aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 20 insertions, 2 deletions
diff --git a/README.md b/README.md
index 7c74a8e..4917782 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,7 @@ Nord Vim is a 16 colorspace theme build to run in GUI- and terminal mode with su
- [Activation](#activation)
- [Configuration](#configuration)
- [Italic comments](#italic-comments)
+ - [Comment contrast](#comment-contrast)
- [Plugin Support](#plugin-support)
- [UI Plugins](#ui-plugins)
- [Language Plugins](#language-plugins)
@@ -109,11 +110,28 @@ All options should be set **before** the [activation](#activation) command!
Enable to use italic font for all comments.
To adhere to the Nord style guide this option is disabled by default.
-It can be enabled by setting the `g:nord_italic_comments` variable to `1`.
+It can be enabled by setting the `g:nord_italic_comments` variable to `1`.
+
```vim
let g:nord_italic_comments = 1
```
+### Comment contrast
+**This option should only be enabled if your terminal emulator supports 24bit true color (16 million colors)!**
+
+This option is only visible if `termguicolors` is enabled in your `~/.vimrc` or set via `:set termguicolors`!
+
+The comment brightness can be increased by 1 - 20 percent. It can be enabled by setting the `g:nord_comment_brightness`
+variable to a number between `1` and `20`.
+
+```vim
+let g:nord_comment_brightness = 12
+```
+
+To adhere to the Nord style guide this option uses `nord3` by default.
+
+More information about true color and the support in various terminals can be found in [this gist][gist-true-color].
+
## Plugin Support
Nord Vim provides support for many third-party language- and the UI plugins.
@@ -159,9 +177,9 @@ Please report issues/bugs, feature requests and suggestions for improvements to
<p align="center"><a href="http://www.apache.org/licenses/LICENSE-2.0"><img src="https://img.shields.io/badge/License-Apache_2.0-5E81AC.svg?style=flat-square"/></a> <a href="https://creativecommons.org/licenses/by-sa/4.0"><img src="https://img.shields.io/badge/License-CC_BY--SA_4.0-5E81AC.svg?style=flat-square"/></a></p>
+[gist-true-color]: https://gist.github.com/XVilka/8346728
[scrot-readme-default-profile]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/src/assets/scrot-readme-default-profile.png
[scrot-readme-lazy-profile-change]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/src/assets/scrot-readme-lazy-profile-change.png
-
[scrot-lang-c]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-lang-c.png
[scrot-lang-css]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-lang-css.png
[scrot-lang-html]: https://raw.githubusercontent.com/arcticicestudio/nord-vim/develop/assets/scrot-lang-html.png