summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMathieu Ablasou <alexherbo2@gmail.com>2020-11-25 15:15:02 +0100
committerMathieu Ablasou <alexherbo2@gmail.com>2020-11-25 15:15:02 +0100
commit41d36e455ced6bfa48c86b9c8e3190468e09e409 (patch)
treed894ab43e9e4bf1bde052b968e69681f9c3e68dc /README.md
parent6af958ce1f7f0b78394ed1a0d4c57d5f5b47f748 (diff)
Installation: Tell users what `make install` does
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
index 669bc79..ac529c2 100644
--- a/README.md
+++ b/README.md
@@ -53,6 +53,30 @@ Run the following in your terminal:
make install
```
+It will install [`kak-shell`] and [`kak-desktop`] to your `~/.local/bin` directory
+and create a [`kakoune-connect.desktop`] desktop entry.
+
+[`kak-shell`]: bin/kak-shell
+[`kak-desktop`]: bin/kak-desktop
+[`kakoune-connect.desktop`]: share/applications/kakoune-connect.desktop
+
+If you want to use Kakoune as your default editor, for example when opening files in [Dolphin],
+open `$XDG_CONFIG_HOME/mimeapps.list` and add the following MIME type association:
+
+[Dolphin]: https://dolphin.kde.org
+
+`~/.config/mimeapps.list`
+
+```
+[Default Applications]
+text/plain=kakoune-connect.desktop
+text/xml=kakoune-connect.desktop
+```
+
+Add more entries to your liking.
+
+---
+
Add [`connect.kak`](rc/connect.kak) and its [modules] to your autoload or source them manually.
``` kak