Update documentation with justl-shell variable

psibi · Jun 24, 2024 · 58e8141 · 58e8141
1 parent e69edc1
commit 58e8141
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/README.org b/README.org
@@ -73,9 +73,9 @@ h => help popup
 ? => help popup
 g => refresh
 e => execute recipe
-E => execute recipe with eshell
+E => execute recipe with a shell
 w => execute recipe with arguments
-W => open eshell without executing
+W => open a shell without executing
 #+end_example
 
 * Customize
@@ -87,6 +87,7 @@ W => open eshell without executing
   change the /justl-executable/ variable to set any explicit path.
 - You can also control the width of the RECIPE column in the justl
   buffer via /justl-recipe width/. By default it has a value of 20.
+- You can change the shell between /eshell/ and /vterm/ using the /justl-shell/ variable. Using vterm requires [[https://github.com/akermu/emacs-libvterm][the vterm package]] to be installed.
 
 * Future
 

diff --git a/justl.el b/justl.el
@@ -51,9 +51,9 @@
 ;; ? => help popup
 ;; g => refresh
 ;; e => execute recipe
-;; E => execute recipe with eshell
+;; E => execute recipe with a shell
 ;; w => execute recipe with arguments
-;; W => open eshell without executing
+;; W => open a shell without executing
 ;;
 ;; Customize:
 ;;
@@ -63,6 +63,9 @@
 ;; You can also control the width of the RECIPE column in the justl
 ;; buffer via `justl-recipe width`.  By default it has a value of 20.
 ;;
+;; You can change the shell between `eshell' and `vterm' using the `justl-shell'
+;; variable. Using vterm requires the `vterm' package to be installed.
+;;
 
 ;;; Code: