/whammy

a window manager for OSX

Primary LanguageLua

Whammy

Whammy is a clone of the i3 window manager for OS X, built on Hammerspoon. It's currently pre-alpha.

Installation

Install Hammerspoon

Whammy requires Hammerspoon, and currently you must install from source. To do so:

Install Cocoapods.

$ git clone https://github.com/tmandry/hammerspoon.git
$ git checkout patch-finder
$ open hammerspoon/Hammerspoon.xcodeproj

and run it inside Xcode.

Install Whammy

$ cd ~/.hammerspoon
$ git clone https://github.com/tmandry/whammy.git
$ ln -s whammy/wm

Set up your configuration

Copy the sample config to ~/.hammerspoon/init.lua.

Finally, click the Hammerspoon icon and "Reload Config", and Whammy is running.

Usage

Learn how to use i3 (video, user guide). The commands in the sample config are similar to its default commands, with the alt key being used and actual vim keys (hjkl) being used to control direction.

Development

Running tests

$ brew install luarocks
$ luarocks install busted
$ cd path/to/whammy
$ busted