diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..9d303ef1 --- /dev/null +++ b/README.md | |||
@@ -0,0 +1,47 @@ | |||
1 | # sway | ||
2 | |||
3 | "**S**irCmpwn's **Way**land window manager" | ||
4 | |||
5 | sway is an i3-compatible window manager for | ||
6 | [Wayland](http://wayland.freedesktop.org/). | ||
7 | |||
8 | ![](https://sr.ht/7DsT.png) | ||
9 | |||
10 | ## Rationale | ||
11 | |||
12 | I use i3 on xorg. Wayland is coming, and [i3way](http://i3way.org/) still has | ||
13 | zero lines of source code after two years. | ||
14 | |||
15 | ## Status | ||
16 | |||
17 | Not really usable yet. | ||
18 | |||
19 | ## Compile / Install | ||
20 | |||
21 | Dependencies: | ||
22 | |||
23 | * cmake | ||
24 | * [wlc](https://github.com/Cloudef/wlc) | ||
25 | * xkb | ||
26 | |||
27 | Notably missing: weston is not required. | ||
28 | |||
29 | cmake . | ||
30 | make | ||
31 | # sudo make install | ||
32 | |||
33 | Binary shows up in `./bin` (or `/usr/bin` if you `make install`). | ||
34 | |||
35 | ## Configuration | ||
36 | |||
37 | mkdir ~/.sway | ||
38 | cp ~/.i3/config ~/.sway/config | ||
39 | |||
40 | [See also](http://i3wm.org/docs/) | ||
41 | |||
42 | ## Running | ||
43 | |||
44 | sway | ||
45 | |||
46 | If you run this while xorg is running, it'll run inside of an x window (useful | ||
47 | for testing). Otherwise, it'll run wayland properly. | ||