diff options
author | Drew DeVault <ddevault@linode.com> | 2015-08-18 16:16:13 -0400 |
---|---|---|
committer | Drew DeVault <ddevault@linode.com> | 2015-08-18 16:16:42 -0400 |
commit | be871731e127d695d7c79dff185d55be95e20cf5 (patch) | |
tree | 8119376627e6bc8419bb366a32b0c7939f254fd2 /README.md | |
parent | Merge pull request #71 from Luminarys/master (diff) | |
download | sway-be871731e127d695d7c79dff185d55be95e20cf5.tar.gz sway-be871731e127d695d7c79dff185d55be95e20cf5.tar.zst sway-be871731e127d695d7c79dff185d55be95e20cf5.zip |
Improve README
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 45 |
1 files changed, 19 insertions, 26 deletions
@@ -1,14 +1,12 @@ | |||
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 | i3-compatible window manager for [Wayland](http://wayland.freedesktop.org/). | ||
4 | 5 | ||
5 | sway is a **work in progress** i3-compatible window manager for | 6 | [FAQ & wiki](https://github.com/SirCmpwn/sway/wiki) |
6 | [Wayland](http://wayland.freedesktop.org/). | ||
7 | 7 | ||
8 | ![](https://sr.ht/qxGE.png) | 8 | ![](https://sr.ht/qxGE.png) |
9 | 9 | ||
10 | Chat on #sway on irc.freenode.net | ||
11 | |||
12 | ## Rationale | 10 | ## Rationale |
13 | 11 | ||
14 | I use i3 on xorg. Wayland is coming, and [i3way](http://i3way.org/) still has | 12 | I use i3 on xorg. Wayland is coming, and [i3way](http://i3way.org/) still has |
@@ -20,44 +18,39 @@ zero lines of source code after two years. | |||
20 | 18 | ||
21 | ## Installation | 19 | ## Installation |
22 | 20 | ||
23 | ### Arch Linux | 21 | ### From Packages |
22 | |||
23 | sway is not supported by many distributions yet. Here's a list of packages | ||
24 | available for you to install: | ||
24 | 25 | ||
25 | Install [aur/sway-git](https://aur.archlinux.org/packages/sway-git/). | 26 | * [Arch Linux](https://aur.archlinux.org/packages/sway-git/). |
26 | 27 | ||
27 | ### Manual | 28 | ### Compiling from Source |
28 | 29 | ||
29 | Dependencies: | 30 | Install dependencies: |
30 | 31 | ||
31 | * cmake | 32 | * cmake |
32 | * [wlc](https://github.com/Cloudef/wlc) | 33 | * [wlc](https://github.com/Cloudef/wlc) |
33 | * xwayland | 34 | * xwayland |
34 | * asciidoc | 35 | * asciidoc |
35 | 36 | ||
36 | Compiling: | 37 | Run these commands: |
37 | 38 | ||
38 | cmake . | 39 | cmake . |
39 | make | 40 | make |
40 | # sudo make install | 41 | sudo make install |
41 | |||
42 | Binary shows up in `./bin` (or `/usr/local/bin` if you `make install`). | ||
43 | 42 | ||
44 | ## Configuration | 43 | ## Configuration |
45 | 44 | ||
46 | mkdir ~/.config/sway | 45 | If you already use i3, then copy your i3 config to `~/.config/sway/config` and |
47 | cp ~/.config/i3/config ~/.config/sway/ | 46 | it'll work out of the box. Otherwise, copy `/etc/sway/config` to |
48 | 47 | `~/.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 | 48 | ||
58 | ## Running | 49 | ## Running |
59 | 50 | ||
51 | Run this from a tty (instead of starting x): | ||
52 | |||
60 | sway | 53 | sway |
61 | 54 | ||
62 | If you run this while xorg is running, it'll run inside of an x window (useful | 55 | 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. | 56 | hardware directly (useful for development). |