From 607d2ef5acb4e5c6d3ab97492c02cc1e96927725 Mon Sep 17 00:00:00 2001 From: emersion Date: Sun, 13 Aug 2017 18:56:30 +0200 Subject: [PATCH] Document config file in README --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cbd32fd..360e91a 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,28 @@ For now, it only supports: ## Usage -``` +```sh cargo install kanshi +touch ~/.config/kanshi/config kanshi > ~/.config/sway/outputs ``` +### Configuration file + +Each monitor configuration is delimited by brackets. Each line has the same +syntax as `sway(5)`. + +``` +{ + output LVDS-1 disable + output VGA-1 resolution 1600x900 position 0,0 +} + +{ + output LVDS-1 vendor CMN product 0x1484 serial 0x0 resolution 1600x900 scale 2 +} +``` + ## License MIT