From 41d36e455ced6bfa48c86b9c8e3190468e09e409 Mon Sep 17 00:00:00 2001 From: Mathieu Ablasou Date: Wed, 25 Nov 2020 15:15:02 +0100 Subject: Installation: Tell users what `make install` does --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) 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 -- cgit v1.2.3