Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1.4 KB

README.md

File metadata and controls

53 lines (33 loc) · 1.4 KB

Worm

Worm is a tiny, dynamic, tag-based window manager written in the Nim language. It supports both a floating mode and master-stack tiling with gaps and struts. Check out the screenshots on the wiki for some examples of how it looks.

Build / install

Install Nim >= 1.6.0, for example through Choosenim. Clone this repo and run

$ nimble build -d:release

And you should end up with two binaries; strip and use!

Alternatively, for users using Arch, you can use the AUR package worm-git.

$ yay -S worm-git

Configuration

Autostart

Worm will try to execute the file ~/.config/worm/rc on startup. Simply create it as a shell-script to execute your favorite applications with worm. (don't forget to make it executable).

An example can be found here.

Keybindings

Worm does not have a built-in keyboard mapper, so you should use something like sxhkd. Please read the docs to understand how wormc works before writing your own sxhkdrc.

An example sxhkdrc can be found here.

License

Licensed under the MIT license. See the LICENSE file for more info.

Credits

Thanks to phisch for making the logo!

Thanks to everyone else that's opened an issue, a PR, or just tried out worm.