commit 508a772e116ec1fa9ca9052b80911a821275b8c5
parent 6886b55c173472c02e454d523351d91401595def
Author: JayVii <jayvii[AT]posteo[DOT]de>
Date: Wed, 16 Oct 2024 10:16:05 +0200
feat: update readme with install instructions
Diffstat:
1 file changed, 14 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -21,6 +21,20 @@ The snippets in "helix_config.toml" belong into your helix configuration
You need "tmux" to be installed on your system. An example configuration is
provided in "tmux.conf", which you can copy to "~/.tmux.conf"
+For simplicity, you can use the supplied `Makefile`, which does all of this in
+one command:
+
+```bash
+make install
+```
+
+For updating helix-term, simply pull the newest version from git
+(or use the tarball) and run:
+
+```bash
+make update
+```
+
## Usage
Working on some script in helix, execute the "helix-term" command in another
