aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGabriele Bozzola <sbozzolator@gmail.com>2020-05-03 22:44:07 -0700
committerGitHub <noreply@github.com>2020-05-03 22:44:07 -0700
commit8f00dc90abbdb101b94bf63f9b1cb0ac9a147f40 (patch)
treef965e4c11cb397d4a97909f054df7ed2b9916035 /README.md
parent8de80d7415b413c308f51dfb987ca451b144f3b1 (diff)
parent887b01adadb86e909f4e3d0de014c3dcb2626e5a (diff)
Merge pull request #293 from condy0919/master
Automatic detection for system libvterm first
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index d73181f..918e112 100644
--- a/README.md
+++ b/README.md
@@ -64,12 +64,12 @@ Clone the repository:
git clone https://github.com/akermu/emacs-libvterm.git
```
-In case you want to use the version of libvterm already installed on your
-system, change `cmake ..` with `cmake -DUSE_SYSTEM_LIBVTERM=yes ..` in the
-following instructions. If `-DUSE_SYSTEM_LIBVTERM` is not explicitly set to
-`yes` (or if it is set to `no`), emacs-libvterm will download the latest version
-available of libvterm (from [here](https://github.com/neovim/libvterm)), compile
-it, and use it.
+By default, vterm will try to find if libvterm is installed. If it is not found,
+emacs-libvterm will download the latest version available of libvterm (from
+[here](https://github.com/neovim/libvterm)), compile it, and use it. If you
+always want to use the vendored version as opposed to the one on you system, set
+`USE_SYSTEM_LIBVTERM` to `Off`. To do this, change `cmake ..` with `cmake
+-DUSE_SYSTEM_LIBVTERM=Off ..` in the following instructions.
Build the module with: