aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGabriele Bozzola <sbozzolator@gmail.com>2019-10-12 07:54:27 -0700
committerGabriele Bozzola <sbozzolator@gmail.com>2019-10-12 07:54:27 -0700
commit03e4ccc0ed54862159a56f37d0d982bb4891687a (patch)
tree44f65f22ad1ae7a16cac70672b46de2daafc82b7 /README.md
parent0702e964636808a7aa3aa0c3fc61ad4644938c6f (diff)
Update README to reflect #153 and availability on MELPA
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
index 93ce9b5..1fc4c35 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,8 @@ This is an **alpha release**, so it will crash your emacs. If it does, please
# Installation
+## Manual
+
Clone the repository:
```sh
@@ -47,6 +49,30 @@ And add this to your `init.el`:
(require 'vterm)
```
+Or, with `use-package`:
+
+```elisp
+(use-package vterm
+ :load-path "path/to/emacs-libvterm/"
+)
+```
+
+## From MELPA
+
+`vterm` is available on [MELPA](https://melpa.org/), and it can be installed as
+a normal package. If the requirements are satisfied (mainly, Emacs was built
+with support for modules), `vterm` will take care of the compilation of all its
+components.
+
+`vterm` can be install with MELPA with `use-package` by adding the following
+lines to your `init.el`:
+
+```elisp
+(use-package vterm
+ :ensure t
+)
+```
+
# Debugging and testing
If you have successfully built the module, you can test it by executing the
@@ -79,6 +105,13 @@ possible to copy the text and leave `vterm-copy-mode` with the enter key.
Shell to run in a new vterm. It defaults to `$SHELL`.
+## `vterm-term-environment-variable`
+
+Value for the `TERM` environment variable. It defaults to `xterm-256color`. If
+[eterm-256color](https://github.com/dieggsy/eterm-256color) is installed,
+setting `vterm-term-environment-variable` to `eterm-color` improves the
+rendering of colors in some systems.
+
## Keybindings
If you want a key to be sent to the terminal, bind it to `vterm--self-insert`,