aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md46
1 files changed, 19 insertions, 27 deletions
diff --git a/README.md b/README.md
index 8c312984..a51a0a86 100644
--- a/README.md
+++ b/README.md
@@ -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 4i3-compatible window manager for [Wayland](http://wayland.freedesktop.org/).
5sway is a **work in progress** i3-compatible window manager for 5Read 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
10Chat on #sway on irc.freenode.net
11
12## Rationale 9## Rationale
13 10
14I use i3 on xorg. Wayland is coming, and [i3way](http://i3way.org/) still has 11I 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
22sway is not supported by many distributions yet. Here's a list of packages
23available for you to install:
24 24
25Install [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
29Dependencies: 29Install 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
36Compiling: 36Run these commands:
37 37
38 cmake . 38 cmake .
39 make 39 make
40 # sudo make install 40 sudo make install
41
42Binary shows up in `./bin` (or `/usr/local/bin` if you `make install`).
43 41
44## Configuration 42## Configuration
45 43
46 mkdir ~/.config/sway 44If you already use i3, then copy your i3 config to `~/.config/sway/config` and
47 cp ~/.config/i3/config ~/.config/sway/ 45it'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.
49Or if you don't already use i3:
50
51 mkdir ~/.config/sway
52 cp /etc/sway/config ~/.config/sway/
53
54Edit to your liking.
55
56[See also](http://i3wm.org/docs/)
57 47
58## Running 48## Running
59 49
50Run this from a tty (instead of starting x):
51
60 sway 52 sway
61 53
62If you run this while xorg is running, it'll run inside of an x window (useful 54If you run it from within x, it will spawn x windows instead of using your
63for testing). Otherwise, it'll run wayland properly. 55hardware directly (useful for development).