From 2f37ca7a17a348a4b9c6c07c0ef9b6534c907883 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lukas=20F=C3=BCrmetz?= <fuermetz@mailbox.org>
Date: Fri, 16 Aug 2019 19:37:43 +0200
Subject: Clarify colors in README and doctext

Fixes #130
---
 README.md |  5 ++++-
 vterm.el  | 36 ++++++++++++++++++------------------
 2 files changed, 22 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index f77cf03..6b582a7 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,8 @@ installed
     You can check that, by verifying that `module-file-suffix` is not `nil`.
  2. cmake (>=3.11)
  3. libtool-bin (related issues: [#66](https://github.com/akermu/emacs-libvterm/issues/66) [#85](https://github.com/akermu/emacs-libvterm/issues/85#issuecomment-491845136))
+ 4. If you compile vterm with `-DUSE_SYSTEM_LIBVTERM` make sure you have the
+    library from https://github.com/neovim/libvterm
 
 Run the build:
 
@@ -84,7 +86,8 @@ C-c`.
 ## Colors
 
 Set the `:foreground` and `:background` attributes of the following faces to a
-color you like:
+color you like. The `:foreground` is ansi color 0-7, the `:background` attribute
+is ansi color 8-15.
 
 - vterm-color-default
 - vterm-color-black
diff --git a/vterm.el b/vterm.el
index 3ff25e8..2561787 100644
--- a/vterm.el
+++ b/vterm.el
@@ -126,64 +126,64 @@ for different shell"
 (defface vterm-color-default
   `((t :inherit default))
   "The default normal color and bright color.
-the foreground color are used for normal color,
-and background color are used for bright color. "
+The foreground color is used as ANSI color 0 and the background
+color is used as ANSI color 7."
   :group 'vterm)
 
 (defface vterm-color-black
   `((t :inherit term-color-black))
   "Face used to render black color code.
-the foreground color are used for normal color,
-and background color are used for bright color. "
+The foreground color is used as ANSI color 0 and the background
+color is used as ANSI color 8."
   :group 'vterm)
 
 (defface vterm-color-red
   `((t :inherit term-color-red))
   "Face used to render red color code.
-the foreground color are used for normal color,
-and background color are used for bright color. "
+The foreground color is used as ANSI color 1 and the background
+color is used as ANSI color 9."
   :group 'vterm)
 
 (defface vterm-color-green
   `((t :inherit term-color-green))
   "Face used to render green color code.
-the foreground color are used for normal color,
-and background color are used for bright color. "
+The foreground color is used as ANSI color 2 and the background
+color is used as ANSI color 10."
   :group 'vterm)
 
 (defface vterm-color-yellow
   `((t :inherit term-color-yellow))
   "Face used to render yellow color code.
-the foreground color are used for normal color,
-and background color are used for bright color. "
+The foreground color is used as ANSI color 3 and the background
+color is used as ANSI color 11."
   :group 'vterm)
 
 (defface vterm-color-blue
   `((t :inherit term-color-blue))
   "Face used to render blue color code.
-the foreground color are used for normal color,
-and background color are used for bright color. "
+The foreground color is used as ANSI color 4 and the background
+color is used as ANSI color 12."
   :group 'vterm)
 
 (defface vterm-color-magenta
   `((t :inherit term-color-magenta))
   "Face used to render magenta color code.
-the foreground color are used for normal color,
-and background color are used for bright color. "
+The foreground color is used as ansi color 5 and the background
+color is used as ansi color 13."
   :group 'vterm)
 
 (defface vterm-color-cyan
   `((t :inherit term-color-cyan))
   "Face used to render cyan color code.
-the foreground color are used for normal color,
-and background color are used for bright color. "
+The foreground color is used as ansi color 6 and the background
+color is used as ansi color 14."
   :group 'vterm)
 
 (defface vterm-color-white
   `((t :inherit term-color-white))
   "Face used to render white color code.
-the foreground color are used for normal color,
-and background color are used for bright color. "
+The foreground color is used as ansi color 7 and the background
+color is used as ansi color 15."
   :group 'vterm)
 
 (defvar vterm-color-palette
-- 
cgit v1.0