https://github.com/tmandry/whammy

a window manager for OSX
https://github.com/tmandry/whammy

Last synced: 2 months ago
JSON representation

a window manager for OSX

• Host: GitHub
• URL: https://github.com/tmandry/whammy
• Owner: tmandry
• Created: 2014-12-24T04:42:30.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2015-08-06T00:05:03.000Z (over 9 years ago)
• Last Synced: 2024-10-14T11:52:33.380Z (3 months ago)
• Language: Lua
• Size: 281 KB
• Stars: 49
• Watchers: 6
• Forks: 6
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Whammy

Whammy is a clone of the [i3 window manager](https://i3wm.org/) for OS X, built on [Hammerspoon](http://www.hammerspoon.org/). It's currently pre-alpha.

## Installation

### Install Hammerspoon

Whammy requires [Hammerspoon](http://www.hammerspoon.org/), and currently you must install from source. To do so:

[Install Cocoapods](https://guides.cocoapods.org/using/getting-started.html).

```sh

$ git clone https://github.com/tmandry/hammerspoon.git

$ git checkout patch-finder

$ open hammerspoon/Hammerspoon.xcodeproj

```

and run it inside Xcode.

### Install Whammy

```sh

$ cd ~/.hammerspoon

$ git clone https://github.com/tmandry/whammy.git

$ ln -s whammy/wm

```

### Set up your configuration

Copy the [sample config](https://github.com/tmandry/whammy/wiki/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](https://www.youtube.com/watch?v=Wx0eNaGzAZU), [user guide](https://i3wm.org/docs/userguide.html)).** The commands in the [sample config](https://github.com/tmandry/whammy/wiki/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

```sh

$ brew install luarocks

$ luarocks install busted

$ cd path/to/whammy

$ busted

```