sway/README.md
2015-08-18 16:18:15 -04:00

56 lines
1.2 KiB
Markdown

# sway
"**S**irCmpwn's **Way**land window manager" is a **work in progress**
i3-compatible window manager for [Wayland](http://wayland.freedesktop.org/).
Read the [FAQ](https://github.com/SirCmpwn/sway/wiki).
![](https://sr.ht/qxGE.png)
## Rationale
I use i3 on xorg. Wayland is coming, and [i3way](http://i3way.org/) still has
zero lines of source code after two years.
## Status
[See "i3 feature support"](https://github.com/SirCmpwn/sway/issues/2)
## Installation
### From Packages
sway is not supported by many distributions yet. Here's a list of packages
available for you to install:
* [Arch Linux](https://aur.archlinux.org/packages/sway-git/).
### Compiling from Source
Install dependencies:
* cmake
* [wlc](https://github.com/Cloudef/wlc)
* xwayland
* asciidoc
Run these commands:
cmake .
make
sudo make install
## Configuration
If you already use i3, then copy your i3 config to `~/.config/sway/config` and
it'll work out of the box. Otherwise, copy `/etc/sway/config` to
`~/.config/sway/config`. Run `man 5 sway` for information on the configuration.
## Running
Run this from a tty (instead of starting x):
sway
If you run it from within x, it will spawn x windows instead of using your
hardware directly (useful for development).