|
1 | | -<h1><img src="https://github.com/fikovnik/ShiftIt/raw/master/artwork/ShiftIt.png" width="72" height="72" valign="middle"/>ShiftIt </h1> |
| 1 | +<h1><img src="https://raw.github.com/fikovnik/ShiftIt/develop/artwork/ShiftIt.png" width="72" height="72" valign="middle"/>ShiftIt <a href="https://travis-ci.org/fikovnik/ShiftIt"><img src="https://travis-ci.org/fikovnik/ShiftIt.png?branch=develop" valign="middle" alt="Build Status (develop branch)"/></a></h1> |
2 | 2 |
|
3 | 3 | *Managing window size and position in OSX* |
4 | 4 |
|
5 | | -**Before the next release is available, please have a look at the `develop` branch.** |
| 5 | +# About |
6 | 6 |
|
7 | | -About |
8 | | --------- |
| 7 | +ShiftIt is an application for OSX that allows you to quickly manipulate window position and size using keyboard shortcuts. |
| 8 | +It intends to become a full featured window organizer for OSX. |
| 9 | +It is a complete rewrite of the original [ShiftIt](http://code.google.com/p/shiftit/) by Aravindkumar Rajendiran which is not longer under development. |
| 10 | +For discussing any sort of stuff about this app, please create a [new issue](https://github.com/fikovnik/ShiftIt/issues). |
9 | 11 |
|
10 | | -ShiftIt is an application for OSX that allows you to quickly manipulate window position and size using keyboard shortcuts. It intends to become a full featured window organizer for OSX. |
11 | | -It is a fork from the original [ShiftIt][1] by [Aravindkumar Rajendiran][2] which is not longer under development. For discussing any sort of stuff about this app, please create a new issue [right here][3] in github. There is also quite a quiet [google group][4], but it's better to post stuff directly here. |
| 12 | +License: [GNU General Public License v3](http://www.gnu.org/licenses/gpl.html) |
12 | 13 |
|
13 | | -License: [GNU General Public License v3][5] |
| 14 | +Change logs: change logs are versioned in the [repository](https://github.com/fikovnik/ShiftIt/tree/develop/release) as well. |
14 | 15 |
|
15 | | -Requirements |
16 | | ------------- |
| 16 | +## Download |
17 | 17 |
|
18 | | -The primary development is done on OSX 10.6 Snow Leopard, but it should be running under OSX 10.5 Leopard as well. |
| 18 | +A binary build for OSX 10.7+ is available in [releases](https://github.com/fikovnik/ShiftIt/releases). |
19 | 19 |
|
20 | | -Compiling |
21 | | ---------- |
| 20 | +## User guide |
22 | 21 |
|
23 | | -After cloning or download a snapshot of the repository (*master branch |
24 | | -is recommended*): |
| 22 | +ShiftIt installs itself in the menu bar (optionally it can be completely hidden). |
| 23 | +It provides a set of actions that manipulates windows positions and sizes. |
| 24 | +Following is an example of list of actions available: |
25 | 25 |
|
26 | | - * on OSX 10.6 Snow Leopard |
27 | | - 1. Compile in XCode by clicking build, or use the |
28 | | - `scripts/release.sh` (*With the script option, please ignore any errors related to the signing the release. Just check if you see the `** BUILD SUCCEEDED **` message in the output and grab the app from `ShiftIt/build/Release/ShiftIt.app` directory.*) |
29 | | - 1. That's it |
30 | | - * on OSX 10.5 Leopard |
31 | | - 1. Go to `Project` menu and click `Edit Project Settings` item |
32 | | - 1. Select `Build` tab |
33 | | - 1. Set `Architectures` to be `32-bit Universal` |
34 | | - 1. Select `C/C++ Compiler Version` to be `GCC 4.2` |
35 | | - 1. Check `Build Active Architecture Only` |
36 | | - |
37 | | -The reason for this is that the Interface Builder frameworks on OS X Leopard 10.5 do not have 64-Bit capabilities. |
| 26 | + |
38 | 27 |
|
39 | | -Note: If you have a problem with the build - xcode complaining about the ShortcutRecorder IB plugin then download (from [here][7]) and build it yourself. Once done load it into the Interface Builder (double click on the just built ShortcutRecorder.ibplugin). |
| 28 | +Normally, all Cocoa windows and X11 windows are supported. |
| 29 | +Some applications might not work correctly or not at all. |
| 30 | +There is a [list of known problems](https://github.com/fikovnik/ShiftIt/wiki/Application-Compatibility-Issues). |
| 31 | +If you find any problem not mentioned there, please submit an issue. |
40 | 32 |
|
41 | | -FAQ |
42 | | ---- |
| 33 | +## Requirements |
43 | 34 |
|
44 | | -**I disabled the `Show Icon in Menu Bar` in the preferences, how can I get it back?how can I get it back?** |
| 35 | +* OSX 10.7+, 64-bit |
| 36 | + |
| 37 | +The primary development is done on OSX 10.10, but it should be running under OSX 10.7 as well. |
| 38 | + |
| 39 | +## FAQ |
| 40 | + |
| 41 | +##### I disabled the _Show Icon in Menu Bar_ in the preferences, how can I get it back? |
45 | 42 |
|
46 | 43 | Launch the application again. It will open the preference dialog. |
47 | 44 |
|
48 | | -3rd Party Frameworks |
49 | | --------------------- |
| 45 | +##### I pressed a shortcut, but nothing has happened, why? |
| 46 | + |
| 47 | +While most of application windows should work well with ShiftIt, there are some exceptions (like the GTK+ OSX applications). There is a [list of known problems](https://github.com/fikovnik/ShiftIt/wiki/Application-Compatibility-Issues). If you find any problem not mentioned in the list, please raise an issue. |
| 48 | + |
| 49 | +##### I pressed a shortcut, something happened, but not what I expected, why? |
| 50 | + |
| 51 | +ShiftIt is based on a Cocoa Accessibility API and sometimes this API can be a bit [fragile](http://lists.apple.com/archives/accessibility-dev/2011/Aug/msg00031.html) and not do exactly what it should. In order to help to improve ShiftIt, please submit an issue every time you find some weird behavior. Before you do please consult the [list of known problems](https://github.com/fikovnik/ShiftIt/wiki/Application-Compatibility-Issues). Thanks! |
| 52 | + |
| 53 | +##### ShiftIt wants accessibility access on my Mac but my system preferences don't match the instruction, why? |
| 54 | + |
| 55 | +For instructions on accessibility in Mac OS X 10.9.x, see [this comment](https://github.com/fikovnik/ShiftIt/issues/110#issuecomment-20834932). |
| 56 | + |
| 57 | +##### How to repairing Accessibility API permissions? |
| 58 | + |
| 59 | +This can be done either using GUI in _System Preferences_ -> _Security & Privacy_ -> _Privacy_ -> _Accessibility_ where it is necessary to check and uncheck the checkbox which is next to ShiftIt in the _Allow the apps below to control your computer_. |
| 60 | + |
| 61 | + |
| 62 | + |
| 63 | +Alternatively, this can be also done in a command line, however, this is rather a hack with all potential issues hacks come with. |
| 64 | + |
| 65 | +```sh |
| 66 | +$ sudo sqlite3 '/Library/Application Support/com.apple.TCC/TCC.db' 'update access set allowed=1 where client like "%org.shiftitapp.ShiftIt%"' |
| 67 | +``` |
| 68 | + |
| 69 | +## Development |
| 70 | + |
| 71 | +The repository is based on the git flow model. The development therefore happens in the `develop` branch. Any contribution is welcomed! |
| 72 | + |
| 73 | +### Local build |
| 74 | + |
| 75 | +To build ShiftIt locally just clone the repository or get the latest snapshot and execute following command in the `ShiftIt` directory: |
| 76 | + |
| 77 | +```sh |
| 78 | +$ xcodebuild -target ShiftIt -configuration Release |
| 79 | +``` |
| 80 | + |
| 81 | +To make a build without X11 support execute following: |
| 82 | + |
| 83 | +```sh |
| 84 | +$ xcodebuild -target "ShiftIt NoX11" -configuration Release |
| 85 | +``` |
| 86 | + |
| 87 | +### Making a release |
| 88 | + |
| 89 | +Releases are handled using [fabric](http://docs.fabfile.org/en/1.5/). There are some dependencies that can be easily obtained using `pip`: |
| 90 | + |
| 91 | +* [fabric](http://docs.fabfile.org/en/1.5/) - the build system itself |
| 92 | +* [github3](https://github.com/sigmavirus24/github3.py) - library for GitHub 3 API |
| 93 | +* [pystache](https://github.com/defunkt/pystache) - templates |
50 | 94 |
|
51 | | - * [ShortcutRecorder][7] framework (*New BSD license*) for capturing key bindings during hotkey reconfiguration. (*from version 1.4*) |
52 | | - * [FMT][8] framework (*MIT license*) for some utility functions like handling login items, hot keys, etc. (*from version 1.5*) |
| 95 | +The releases are fully automatic which hopefully will help to release more often. |
53 | 96 |
|
54 | | -Change Log: |
55 | | ---------------------------- |
| 97 | +**Available commands** |
56 | 98 |
|
57 | | - - [1.5][9] |
58 | | - - [1.4.1][10] |
59 | | - - [1.4][11] |
60 | | - - [1.3][12] |
| 99 | +* `archive` - Archives build |
| 100 | +* `build` - Makes a build by executing xcodebuild |
| 101 | +* `info` - Output all the build properties |
| 102 | +* `release` - Prepare the release: sign the build, generate appcast, generate release notes |
| 103 | +* `release_notes` - Generate release notes |
61 | 104 |
|
| 105 | +After `fab release` instructions about how to create the actual release at github are printed. |
62 | 106 |
|
63 | | - [1]: http://code.google.com/p/shiftit/ |
64 | | - [2]: http://ca.linkedin.com/in/aravind88 |
65 | | - [3]: https://github.com/fikovnik/ShiftIt/issues |
66 | | - [4]: http://groups.google.com/group/shiftitapp |
67 | | - [5]: http://www.gnu.org/licenses/gpl.html |
68 | | - [7]: http://code.google.com/p/shortcutrecorder/ |
69 | | - [8]: https://github.com/fikovnik/FMT |
70 | | - [9]: http://nkuyu.net/apps/shiftit/release-notes-1.5.html |
71 | | - [10]: http://nkuyu.net/apps/shiftit/release-notes-1.4.1.html |
72 | | - [11]: http://nkuyu.net/apps/shiftit/release-notes-1.4.html |
73 | | - [12]: http://nkuyu.net/apps/shiftit/release-notes-1.3.html |
| 107 | +Thanks [JetBrains](http://www.jetbrains.com/) for kindly supporting this open source project by providing [AppCode](http://www.jetbrains.com/objc/) IDE. |
0 commit comments