Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tarkah committed May 8, 2020
1 parent f72d02b commit ab951d0
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

A simple tiling window manager for Windows, written in Rust. Inspired by Budgie Window Shuffler's grid functionality. Currently only tested on a single monitor.

- [Demo](#demo)
- [Download](#download)
- [Usage](#usage)
- [Config](#config)
- [TODO](#todo)

## Demo

Expand All @@ -24,9 +29,12 @@ Click for full video
- Select a window you want resized, then click on a tile in the grid. Window will resize to that zone.
- Hold `SHIFT` down while hovering after a selection, zone will increase in size across all tiles. Select again to resize to larger zone.

## Config

- A configuration file will be created at `%APPDATA%\grout\config.yml` that can be customized. You can also open the config file from the system tray icon.

## TODO

- Multi-monitor support
- System tray icon
- Settings window to edit hotkey & margin config
- Settings window with hotkey configuration
- Option to autostart

0 comments on commit ab951d0

Please sign in to comment.