Skip to content

Commit

Permalink
Added section on halves to thirds
Browse files Browse the repository at this point in the history
  • Loading branch information
rxhanson authored Nov 20, 2019
1 parent 9c0b129 commit 31b66c9
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ Rectangle is a window management app based on Spectacle, written in Swift.
## System Requirements
Rectangle arbitrarily supports macOS v10.12+. If you're willing to test on earlier versions of macOS, this can be updated.

## Keyboard Shortcuts
## Keyboard Shortcuts
The default keyboard shortcuts are based on Spectacle, but there is a recommended alternative set of defaults based on the Magnet app. This can be enabled by setting "alternateDefaultShortcuts" to true in NSUserDefaults for Rectangle with the following Terminal command:

`defaults write com.knollsoft.Rectangle alternateDefaultShortcuts -bool true`

Then restart the Rectangle app.
Then restart the Rectangle app.

## Differences with Spectacle
## Differences with Spectacle
Spectacle used its own keyboard shortcut recorder, while Rectangle uses [MASShortcut](https://github.com/shpakovski/MASShortcut), a well maintained open source library for shortcut recording in macOS apps. This cuts down dramatically on the number of bugs that were only in Spectacle because of the custom shortcut recorder.

### Additional features
Expand All @@ -21,8 +21,19 @@ Spectacle used its own keyboard shortcut recorder, while Rectangle uses [MASShor
* There's an option to have windows traverse across displays on subsequent left or right executions, similar to what Microsoft provided in Windows 7.
* Windows will snap when dragged to edges/corners of the screen. This can be disabled.

### Details on halves to thirds (subsequent execution of half and quarter actions)
The default behavior for Rectangle is based on Spectacle. Each time you execute a half or quarter action, the width of the window will cycle through the following sizes: 1/2 -> 2/3 -> 1/3.

This behavior can be disabled with the following terminal command:

`defaults write com.knollsoft.Rectangle subsequentExecutionMode -int 2`

Followed by a restart of the app.

Note that the `subsequentExecutionMode` is also tied to the setting for traversing displays in the prefs.

## Contributing
Logic from Rectangle is used in the [Multitouch](https://multitouch.app) app. Code contributors to Rectangle or Spectacle are entitled to a free license of Multitouch.
Logic from Rectangle is used in the [Multitouch](https://multitouch.app) app. Code and localization contributors to Rectangle or Spectacle are entitled to a free license of Multitouch. Both Multitouch and Rectangle also use Sparkle and MASShortcut, so contributors to either of those projects are also entitled to a free license of Multitouch (just send me a direct message on [Gitter](https://gitter.im)).

### Localization
Localization was done using [DeepL](https://www.deepl.com/translator). Since it wasn't done by a person, it's likely that the translations can be improved. If you would like to contribute to localization, all of the translations are held in the Main.strings per language.
Expand Down

0 comments on commit 31b66c9

Please sign in to comment.