Skip to content

Latest commit

 

History

History
103 lines (74 loc) · 3.62 KB

README.md

File metadata and controls

103 lines (74 loc) · 3.62 KB
Raw

Phoenix

The lightweight OS X window manager for hackers

Phoenix is a fork of Zephyros that aims for efficiency and a very small footprint.

  • Current version: 1.1
  • Requires: OS X 10.9 and up

Phoenix was originally authored by Steven Degutis / @sdegutis, it's now maintained by Jason Milkins / @jasonm23

Steven is continuing work on OSX window management in Mjolnir

Install

Install XCode and XCode command line tools, then from a terminal:

git clone https://github.com/jasonm23/phoenix.git
cd phoenix
xcodebuild

When complete you'll find a freshly built Phoenix app in build/release.

To install it just drag-drop it to your /Applications folder.

When you first run Phoenix, you'll need to allow it to control UI. OS X will alert you of this, and open System Preferences > Security

An admin account is required to enable it.

Please Note: the default master branch will always be stable.

Features, bug fixes etc. will be done in topic branches and only merged to master when stable.

No AppStore, No Pre-Built binaries, No Cask...

For the record, I'm not interested in supporting users who can't build Phoenix for themselves, it will do nothing for you without a fair degree of scripting knowledge, so I won't be providing any pre-built binaries here or via any other distribution methods.

I may add a recipe to Homebrew, because I can assume you'll have (1) the ability to use the terminal without weeping, (2) XCode will be installed.

I hope I don't hurt anyone's feelings, if you want something shiny and app-store-ey, you can use Moom (it's quite nice apparently.)

If you like the idea of scripting your own Window Management toolkit with JavaScript, Phoenix is probably going to give you the things you want.

Usage

For ideas, read other people's configs in the wiki -

Also add your own config to the wiki to show other people the cool things you can do.

Documentation

Phoenix can only be scripted in JavaScript.

(...or languages which compile to JavaScript e.g. CoffeeScript, LiveScript, ClojureScript, TypeScript etc. etc.)

License

Released under MIT license.

Copyright (c) 2014 Jason Milkins

Copyright (c) 2013 Steven Degutis

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.