summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Leferry 2 <alexherbo2@gmail.com>2019-04-21 20:18:23 +0200
committerAlex Leferry 2 <alexherbo2@gmail.com>2019-04-23 13:01:30 +0200
commitb4ef5f85bad1270ad85624b1fb6947ea1d7a2d1f (patch)
tree4e2d36d9845cab9e3a4bfb1c24d55e1593dbfb17
parente4d8397bc38b2d9bfd81ae8bfa4498fd15398a82 (diff)
Document global install
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index 35cad51..a702d39 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,12 @@
pathogen-infect /home/user/repositories/github.com/alexherbo2/connect.kak
```
+**Optional** – To install globally:
+
+``` sh
+ln -s $PWD/rc/commands/edit ~/.local/bin/kak-connect
+```
+
## Usage
You can use `:connect` to create a new terminal with `[e]dit`, `[b]uffer` and `VISUAL`, `EDITOR` connected to the client.
@@ -26,6 +32,16 @@ the file will be opened in the client from where `:connect` was executed.
You can also open a buffer by using the `buffer` command (or its alias `b`).
With no argument, `buffer` will list the available buffers.
+If in your workflow you use [one session for all projects],
+it can be useful to have Connect [installed globally](#installation).
+
+**Example** – Shell configuration to default in [Othala] session:
+
+``` sh
+KAKOUNE_SESSION=othala
+alias kak=kak-connect
+```
+
### Examples
``` kak
@@ -94,3 +110,5 @@ Thanks to [@occivink] :heart: for his work on the [:terminal] command to abstrac
[ranger]: https://ranger.github.io
[fzf]: https://github.com/junegunn/fzf
[fd]: https://github.com/sharkdp/fd
+[One session for all projects]: https://discuss.kakoune.com/t/one-session-for-all-projects/473
+[Othala]: https://stargate.fandom.com/wiki/Othala_(planet)