Skip to content
This repository
Newer
Older
100644 133 lines (88 sloc) 6.92 kb
62627b34 »
2011-06-19 added tests & fixed bugs in tile list refactor
1 # shellshape
5d6c7593 »
2011-06-23 cleanup
2 A tiling window manager extension for gnome-shell. Many tiling window managers are an all-or-nothing affair, shellshape allows you to tile your windows when it makes sense, and still provides powerful direct manipulation when you need it. You don't have to give up any of the gnome features you like, so it makes for a very smooth learning curve.
c5156e1a »
2011-06-12 a little bit more readme
3
509e2233 »
2012-04-28 0.4
4 This software is in-development. I use it daily, but it might break stuff. Use at your own risk. Multiple monitor support is not really present, and doing fancy things like "always on top" windows may or may not break it.
62627b34 »
2011-06-19 added tests & fixed bugs in tile list refactor
5
5d6c7593 »
2011-06-23 cleanup
6 I must thank [bluetile][bluetile], for it was the inspiration for this extension and many features are lifted directly from it (although not code, JS and haskell are vastly different beasts).
c5156e1a »
2011-06-12 a little bit more readme
7
07199579 »
2013-12-28 update build scripts & manual install instructions
8 ## Running it
509e2233 »
2012-04-28 0.4
9
07199579 »
2013-12-28 update build scripts & manual install instructions
10 Briefly, `0install run http://gfxmonk.net/dist/0install/shellshape.xml`. If you don't have `0install`, you should install the `zeroinstall-injector` package first.
509e2233 »
2012-04-28 0.4
11 For more details, please see instructions on <http://gfxmonk.net/shellshape/>
12
07199579 »
2013-12-28 update build scripts & manual install instructions
13 You can also install it from [the official gnome shell extensions site](https://extensions.gnome.org/extension/294/shellshape/).
14 This may lag (sometimes months) behind the development release, as they perform manual approval of all updates.
15
16 ### Running a local version
17
21b4caa8 »
2014-06-04 update README with new build steps
18 To build the latest version, you'll need to install `npm` (the node.js package manager). You'll also need python. Then:
07199579 »
2013-12-28 update build scripts & manual install instructions
19
21b4caa8 »
2014-06-04 update README with new build steps
20 1. clone this repo
21 2. run `tools/gup compile`
22 3. If you have 0install, you can then just run:
07199579 »
2013-12-28 update build scripts & manual install instructions
23
30e89bf0 »
2014-06-06 minor fix to readme
24 0install run shellshape-local.xml
07199579 »
2013-12-28 update build scripts & manual install instructions
25
21b4caa8 »
2014-06-04 update README with new build steps
26 Otherwise, you can install the extension to a symlink in ~/.local/share/gnome-shell/extensions using:
27
30e89bf0 »
2014-06-06 minor fix to readme
28 tools/gup dev-install
21b4caa8 »
2014-06-04 update README with new build steps
29
30e89bf0 »
2014-06-06 minor fix to readme
30 To compile stuff (after changing some source code), run `tools/gup compile`. You can add e.g `-j3` to compile stuff in parallel.
07199579 »
2013-12-28 update build scripts & manual install instructions
31
53a4aa05 »
2012-04-16 added some notes on debugging errors and running under arch
32 ## running on arch linux
33
34 You may want to try [this user-maintained package](https://aur.archlinux.org/packages.php?ID=50257) if the normal method doesn't work for you, but I have no idea what it will do to your system.
35
36 ## "It doesn't work"
37
38 If you don't know why, here's some things to check:
39
07199579 »
2013-12-28 update build scripts & manual install instructions
40 - Check the extension is enabled (you can see this in the "Shell Extensions" section of `gnome-tweak-tool`)
41 - See if there are any errors in looking glass that mention shellshape (press alt-F2, type "`lg`" and then click the "Errors" tab)
42 - Check the console output (if running in a console) for any messages that mention shellshape
43 - Check /tmp/shellshape.log after launching with $SHELLSHAPE_DEBUG=all
53a4aa05 »
2012-04-16 added some notes on debugging errors and running under arch
44
45 To report a bug or crash, please see the [github issues page](https://github.com/gfxmonk/shellshape/issues).
46
cae66469 »
2011-07-03 added instructions for running on every login
47 ## Replace gnome-shell
48
49 If you symlink the provided `gnome-shell.desktop` file to `~/.local/share/applications/`, gnome-session will use that to launch gnome-shell instead of the system's gnome-shell. Uninstalling is as simple as removing that file.
50
5d6c7593 »
2011-06-23 cleanup
51 ## Friends
52 This extension is best used with the natural window placement extension.
53
54 Other extensions I use and recommend:
a1ffaa61 »
2011-07-03 fix readme formatting
55
5d6c7593 »
2011-06-23 cleanup
56 - alternate status menu (the fact that this is not default bewilders me)
57 - workspace switcher
a1ffaa61 »
2011-07-03 fix readme formatting
58
5d6c7593 »
2011-06-23 cleanup
59 All of these should be available from your package manager, or [the gnome shell extensions page](https://live.gnome.org/GnomeShell/Extensions)
60
22b7f5f5 »
2012-09-15 readme changes (mostly links to keyboard shortcut graphics)
61 ## Keyboard shortcuts
62
d55e335e » MeisterP
2012-11-04 Fix link in README
63 Are listed at [http://gfxmonk.net/shellshape/](http://gfxmonk.net/shellshape/)
22b7f5f5 »
2012-09-15 readme changes (mostly links to keyboard shortcut graphics)
64 Some helpful folk have created graphical (SVG) versions of the keyboard shortcuts, to serve as a handy reference:
65
66 - [Keyboard overlay image](https://github.com/downloads/gfxmonk/shellshape/keyboardshortcuts.svg) - Jordan Klassen
67 - [Desktop wallpaper](http://dl.dropbox.com/u/1879450/shellshape.svg) - Andreas Wallberg ([source](https://github.com/gfxmonk/shellshape/issues/95))
68
5d6c7593 »
2011-06-23 cleanup
69 ## Hacking
70 The core layout stuff is in `tiling.coffee`. This should run in both the shell and in the web browser (see `interactive/index.html`; useful for testing layout changes). The mutter / gnome-shell integration is provided by the other .js files in the root directory (except for `tiling.js`, it is generated from `tiling.coffee`).
71
ddc6eab1 »
2011-07-04 log to /tmp/shellshape.log depending on SHELLSHAPE_DEBUG environment …
72 ## Debugging
73 If you export `SHELLSHAPE_DEBUG=all`, you will get a debug log written to `/tmp/shellshape.log`. You can set values other than `all` if you want to debug on specific topics (available topics include `extension`, `indicator`, `tiling`, `workspace` and `window`) - they should be set as a comma-delimited string, e.g `SHELLSHAPE_DEBUG=workspace,tiling`.
74
07199579 »
2013-12-28 update build scripts & manual install instructions
75 **Note** debugging like this won't work unless you run using `0install`.
509e2233 »
2012-04-28 0.4
76
fee7b6e8 »
2011-07-01 gpl3 licence
77 ## Licence
78 GPLv3
79
d776e794 »
2012-05-06 added changelog
80 ## Changelog
81
37a20bcb »
2014-06-24 version 0.10.0
82 ### version 0.10
0a7f8422 »
2014-05-31 refactor prefs
83 - Fairly large overhaul to codebase:
84 - Removed coffeescript, now using typescript instead. This is a JavaScript superset (so for the most part it's _just JavaScript_), but with optional static typing.
85 This has improved the quality of the code in a number of places (it uncovered a number of dumb type-related bugs), and removes the need for contributors to know CoffeeScript.
86 - Lots of cleanup of state management. This improves a number of circumstances where shellshape and gnome-shell disagree about the state of windows / workspaces, etc.
87 - Made "default layout" setting apply instantly, rather then require a restart.
88 - Additional misc bugs fixed while going through the codebase.
89
37a20bcb »
2014-06-24 version 0.10.0
90 ### version 0.9
91 - Support for gnome-shell 3.12
92
0d605183 »
2014-03-01 update README
93 ### version 0.8
94 - Preliminary support for multiple monitors
95 - Update screen bounds every time we do a layout
96
f09cfe09 »
2013-11-18 0.7.0
97 ### version 0.7
98 - API changes for gnome-shell 3.10.
99 This makes 0.7 incompatible with anything before 3.10.
100
0ae0cd12 »
2013-07-28 update release scripts to publish via 0repo
101 ### version 0.6.1
102 - Fixed "Shellshape settings" indicator menu in gnome-shell 3.8
103
5c8fa454 »
2013-06-16 update changelog
104 ### version 0.6
105 - Support for gnome-shell 3.8
106 - Support for localisation (plus german translation) thanks to @jonnius
107
fe66e8b1 »
2012-11-04 0.5.4
108 ### version 0.5.4
109 - Support for gnome-shell 3.6
110
868d3b06 »
2012-09-26 0.5.3
111 ### version 0.5.3
112 - Fix error launching dconf-editor from the preferences panel
113
8664ad94 »
2012-09-05 minor packaging changes for issue #56
114 ### version 0.5.2
115 - Updated manifest.json to declare compatibility with gnome-shell 3.4.2
116 - Include LICENCE and README.md files in tarball
117
ba7f27a6 »
2012-05-11 0.5.1
118 ### version 0.5.1
119 - Added blacklist to prevent "Conky" windows from being tiled.
120 - Fixed a number of bugs to do with tracking window movement and sizes.
121 - Switched the "Horizontal" and "Vertical" layouts. You may need to adjust your keyboard shortcuts if you've set them to anything non-default, as the gsettings keys have swapped as well (if you haven't customised shortcuts, the defaults will still do the right thing)..
122
d776e794 »
2012-05-06 added changelog
123 ### version 0.5:
124 - Removed label from indicator icon.
125 - Rework icons to be simpler and look/act like other symbolic icons in the panel.
126 - Added a preferences panel (accessible from the gse website, or `gnome-shell-extension-prefs`).
127 - Added a "max autotile windows" option.
128 - Added the ability to customise keyboard shortcuts from the preferences panel.
129
130 ### version 0.4:
131 - First release on extensions.gnome.org
132
5d6c7593 »
2011-06-23 cleanup
133 [bluetile]: http://bluetile.org/
Something went wrong with that request. Please try again.