From e8dd447d018b2a5d3096082a6b9191c607a7a46e Mon Sep 17 00:00:00 2001 From: Max Verevkin Date: Fri, 1 Apr 2022 22:47:31 +0300 Subject: readme --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 44154c3..843cc63 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,24 @@ A list of things that are missing (for now): - Multiple seat support (river doesn't support this either, so it's fine for now) - The JSON parsing implementation is not "streaming": all blocks should be on the same line +## Installation + +External dependencies: `libpango1.0-dev`. + +Just clone the repo and use `cargo` to build the project: + +``` +git clone https://github.com/MaxVerevkin/i3bar-river +cd i3bar-river +cargo install --path . +``` + +Then add this to the end of your river init script: + +``` +riverctl spawn i3bar-river +``` + ## Configuration The configuration file should be stored in `$XDG_CONFIG_HOME/i3bar-river/config.toml` or `~/.config/i3bar-river/config.toml`. -- cgit v1.3.1