From 52611ab5c70c85194d75c52f8188eebcf4f90bc0 Mon Sep 17 00:00:00 2001 From: Tassilo Horn Date: Sun, 27 Jun 2021 10:16:55 +0200 Subject: [PATCH] Document installation in README.md --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index f2434c4..4244821 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,29 @@ Right now, there are these subcommands: one. (This is useful for accessing swayr commands which are not bound to a key.) +## Installation + +You'll need to install the current stable rust toolchain using the one-liner +shown at the [official rust installation +page](https://www.rust-lang.org/tools/install). + +Then you can install swayr like so: +```sh +cargo install swayr +``` + +For getting updates easily, I recommend the cargo `install-update` plugin. +```sh +# Install it once. +cargo install install-update + +# Then you can update all installed rust binary crates including swayr using: +cargo install-update --all + +# If you only want to update swayr, you can do so using: +cargo install-update -- swayr +``` + ## Usage You need to start the swayr demon `swayrd` in your sway config