aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 18 insertions, 25 deletions
diff --git a/README.md b/README.md
index 454d4ab..d7fb825 100644
--- a/README.md
+++ b/README.md
@@ -10,21 +10,7 @@ report a bug!
# Installation
-First, you need to have `libvterm` installed in your system.
-
-**On Ubuntu / Debian:**
-
-```
-sudo apt-get install libvterm-dev
-```
-
-**On macOS:**
-
-```
-brew install libvterm
-```
-
-Then clone the repository:
+Clone the repository:
```
git clone https://github.com/akermu/emacs-libvterm.git
@@ -79,7 +65,7 @@ Open a terminal in another window.
Shell to run in a new vterm. Defaults to `$SHELL`.
-# Keybindings
+## Keybindings
If you want a key to be send to the terminal bind it to `vterm--self-insert`,
otherwise remove it from `vterm-mode-map`. By default vterm.el binds most of the
@@ -92,12 +78,19 @@ bound to `C-c C-c`.
Set the `:foreground` and `:background` attributes of the following faces to a
color you like:
-- vterm
-- vterm-color-black
-- vterm-color-red
-- vterm-color-green
-- vterm-color-yellow
-- vterm-color-blue
-- vterm-color-magenta
-- vterm-color-cyan
-- vterm-color-white
+- vterm-color-default-fg
+- vterm-color-default-bg
+- vterm-color-black-fg
+- vterm-color-black-bg
+- vterm-color-red-fg
+- vterm-color-green-bg
+- vterm-color-green-fg
+- vterm-color-yellow-bg
+- vterm-color-blue-fg
+- vterm-color-blue-bg
+- vterm-color-magenta-fg
+- vterm-color-magenta-bg
+- vterm-color-cyan-fg
+- vterm-color-cyan-bg
+- vterm-color-white-fg
+- vterm-color-white-bg