diff options
author | Half-Shot <half-shot@molrams.com> | 2015-08-18 21:42:28 +0100 |
---|---|---|
committer | Half-Shot <half-shot@molrams.com> | 2015-08-18 21:42:28 +0100 |
commit | f314d951039031fd7f0bd8772b6916587ebb0846 (patch) | |
tree | 7287a3f02593906ae23aec234fbe6e2ca1b06d1d /README.md | |
parent | Beguin work on the move command. (diff) | |
parent | Improve README (more) (diff) | |
download | sway-f314d951039031fd7f0bd8772b6916587ebb0846.tar.gz sway-f314d951039031fd7f0bd8772b6916587ebb0846.tar.zst sway-f314d951039031fd7f0bd8772b6916587ebb0846.zip |
Merge branch 'master' of https://github.com/SirCmpwn/sway
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 46 |
1 files changed, 19 insertions, 27 deletions
@@ -1,14 +1,11 @@ | |||
1 | # sway | 1 | # sway |
2 | 2 | ||
3 | "**S**irCmpwn's **Way**land window manager" | 3 | "**S**irCmpwn's **Way**land window manager" is a **work in progress** |
4 | 4 | i3-compatible window manager for [Wayland](http://wayland.freedesktop.org/). | |
5 | sway is a **work in progress** i3-compatible window manager for | 5 | Read the [FAQ](https://github.com/SirCmpwn/sway/wiki). |
6 | [Wayland](http://wayland.freedesktop.org/). | ||
7 | 6 | ||
8 | ![](https://sr.ht/qxGE.png) | 7 | ![](https://sr.ht/qxGE.png) |
9 | 8 | ||
10 | Chat on #sway on irc.freenode.net | ||
11 | |||
12 | ## Rationale | 9 | ## Rationale |
13 | 10 | ||
14 | I use i3 on xorg. Wayland is coming, and [i3way](http://i3way.org/) still has | 11 | I use i3 on xorg. Wayland is coming, and [i3way](http://i3way.org/) still has |
@@ -20,44 +17,39 @@ zero lines of source code after two years. | |||
20 | 17 | ||
21 | ## Installation | 18 | ## Installation |
22 | 19 | ||
23 | ### Arch Linux | 20 | ### From Packages |
21 | |||
22 | sway is not supported by many distributions yet. Here's a list of packages | ||
23 | available for you to install: | ||
24 | 24 | ||
25 | Install [aur/sway-git](https://aur.archlinux.org/packages/sway-git/). | 25 | * [Arch Linux](https://aur.archlinux.org/packages/sway-git/). |
26 | 26 | ||
27 | ### Manual | 27 | ### Compiling from Source |
28 | 28 | ||
29 | Dependencies: | 29 | Install dependencies: |
30 | 30 | ||
31 | * cmake | 31 | * cmake |
32 | * [wlc](https://github.com/Cloudef/wlc) | 32 | * [wlc](https://github.com/Cloudef/wlc) |
33 | * xwayland | 33 | * xwayland |
34 | * asciidoc | 34 | * asciidoc |
35 | 35 | ||
36 | Compiling: | 36 | Run these commands: |
37 | 37 | ||
38 | cmake . | 38 | cmake . |
39 | make | 39 | make |
40 | # sudo make install | 40 | sudo make install |
41 | |||
42 | Binary shows up in `./bin` (or `/usr/local/bin` if you `make install`). | ||
43 | 41 | ||
44 | ## Configuration | 42 | ## Configuration |
45 | 43 | ||
46 | mkdir ~/.config/sway | 44 | If you already use i3, then copy your i3 config to `~/.config/sway/config` and |
47 | cp ~/.config/i3/config ~/.config/sway/ | 45 | it'll work out of the box. Otherwise, copy `/etc/sway/config` to |
48 | 46 | `~/.config/sway/config`. Run `man 5 sway` for information on the configuration. | |
49 | Or if you don't already use i3: | ||
50 | |||
51 | mkdir ~/.config/sway | ||
52 | cp /etc/sway/config ~/.config/sway/ | ||
53 | |||
54 | Edit to your liking. | ||
55 | |||
56 | [See also](http://i3wm.org/docs/) | ||
57 | 47 | ||
58 | ## Running | 48 | ## Running |
59 | 49 | ||
50 | Run this from a tty (instead of starting x): | ||
51 | |||
60 | sway | 52 | sway |
61 | 53 | ||
62 | If you run this while xorg is running, it'll run inside of an x window (useful | 54 | If you run it from within x, it will spawn x windows instead of using your |
63 | for testing). Otherwise, it'll run wayland properly. | 55 | hardware directly (useful for development). |