From e38416543ffcb66bec888dcc911d72e4740619b0 Mon Sep 17 00:00:00 2001
From: James Cherti <60946298+jamescherti@users.noreply.github.com>
Date: Sun, 11 Aug 2024 23:41:53 -0400
Subject: [PATCH] Update README.md

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.md b/README.md
index e1ebc20..a91c41c 100644
--- a/README.md
+++ b/README.md
@@ -252,6 +252,23 @@ The `evil-surround` package simplifies handling surrounding characters, such as
   :hook (after-init . global-evil-surround-mode))
 ```
 
+### How to configure vterm
+
+The `emacs-libvterm` package is a terminal emulator integrated into GNU Emacs. Built on libvterm, a C library, it offers superior performance compared to Elisp-based alternatives. This compiled code approach enables `emacs-libvterm` to handle large outputs efficiently, providing a fast and feature-complete terminal experience within Emacs.
+
+To configure `emacs-vterm`, add the following to `~/.emacs.d/post-init.el`:
+``` emacs-lisp
+(use-package vterm
+  :ensure t
+  :defer t
+  :commands vterm
+  :config
+  ;; Speed up vterm
+  (setq vterm-timer-delay 0.01))
+```
+
+(Note that the `emacs-vterm` Emacs package requires compilation of its C components, which includes the gcc compiler and the `libvterm` library. On Debian or Ubuntu systems, the necessary packages can be installed with: `sudo apt-get install build-essential libvterm-dev`)
+
 ### How to configure straight.el?
 
 [Add the straight.el bootstrap code](https://github.com/radian-software/straight.el?tab=readme-ov-file#getting-started) to `~/.emacs.d/pre-init.el`: