aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLukas Fürmetz <fuermetz@mailbox.org>2018-11-11 18:05:14 +0100
committerLukas Fürmetz <fuermetz@mailbox.org>2018-11-11 18:05:14 +0100
commitcad535b6000ec2ba2253e30f93103e0c8218e6d4 (patch)
treee33f2d18c413df5af400a0d4335e3d2399d5fb32
parentae743d62aac3f133acc2d57803d867f7722533cc (diff)
Update README
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 145afd5..9dbe396 100644
--- a/README.md
+++ b/README.md
@@ -10,10 +10,26 @@ report a bug!
# Installation
+You need to have `libvterm` installed, on Linux use your distros package manager, for example:
+
+```
+sudo apt-get install libvterm
+```
+
+On MAC OS X:
+
+```
+hombrew install libvterm
+```
+
+Then clone the repository:
+
```
git clone https://github.com/akermu/emacs-libvterm.git
```
+Run the build:
+
```
mkdir -p build
cd build
@@ -82,5 +98,4 @@ color you like:
# Limitations
-- No support for scrolling (But you can use tmux/screen to emulate scrolling)
- Mouse support is non-existing