add use package instructions

This commit is contained in:
Valentin Boettcher 2024-05-11 19:06:47 -04:00
parent 8aece63590
commit 873820d60e
No known key found for this signature in database
GPG key ID: E034E12B7AF56ACE

View file

@ -13,8 +13,16 @@ The functionalities required for typical REPL interaction have been implemented.
If you want to use Python with [[https://orgmode.org/worg/org-contrib/babel/][Org Babel]], please consider trying [[https://github.com/shg/ob-python-vterm.el][ob-python-vterm]]. It uses python-vterm and provides a solid babel development experience with session and asynchronous execution support.
** Installation
You can install this package from MELPA. The package name is “python-vterm”.
Currently you can only install the package from github. With
~use-package~ and ~straight~ it looks as follows:
#+begin_src elisp
(use-package python-vterm
:straight (:host github :repo "vale981/python-vterm.el")
:hook (python-mode . python-vterm-mode)
:config
(setq-default python-vterm-repl-program "ipython")
(setq-default python-vterm-silent-cells t))
#+end_src
For manual installation, download =python-vterm.el= into somewhere in your local directory and use =package-install-file= command. Please make sure [[https://github.com/PythonEditorSupport/python-emacs][python-mode]] and [[https://github.com/akermu/emacs-libvterm][emacs-libvterm]] are installed and configured correctly.