diff --git a/README.md b/README.md index 5fd7e72..a0deb9c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,45 @@ # swaycycle + Cycle through all visible windows on a sway[fx] workspace + +## Installation + +Checkout the repo and execute `make`. You'll need the go toolkit. Then +copy the binary `swaycycle` to some location within your `$PATH`. + +## Configuration + +Add such a line to your sway config file (e.g. in `$HOME/.config/sway/config`): + +```default +bindsym $mod+Tab exec ~/bin/swaycycle +``` + +## Getting help + +Although I'm happy to hear from swaycycle users in private email, that's the +best way for me to forget to do something. + +In order to report a bug, unexpected behavior, feature requests or to +submit a patch, please open an issue on github: +https://github.com/TLINDEN/swaycycle/issues. + +## Copyright and license + +This software is licensed under the GNU GENERAL PUBLIC LICENSE version 3. + +## Authors + +T.v.Dein + +## Project homepage + +https://github.com/TLINDEN/swaycycle + +## Copyright and License + +Licensed under the GNU GENERAL PUBLIC LICENSE version 3. + +## Author + +T.v.Dein