sway/README.md

58 lines
1.5 KiB
Markdown
Raw Normal View History

2015-09-07 01:52:42 +00:00
# sway [![](https://api.travis-ci.org/SirCmpwn/sway.svg)](https://travis-ci.org/SirCmpwn/sway) [![Donate with fosspay](https://drewdevault.com/donate/static/donate-with-fosspay.png)](https://drewdevault.com/donate?project=4)
2015-08-08 23:39:55 +00:00
2015-08-18 20:16:13 +00:00
"**S**irCmpwn's **Way**land window manager" is a **work in progress**
i3-compatible window manager for [Wayland](http://wayland.freedesktop.org/).
2015-08-18 20:18:15 +00:00
Read the [FAQ](https://github.com/SirCmpwn/sway/wiki).
2015-08-08 23:39:55 +00:00
2015-08-10 12:31:53 +00:00
![](https://sr.ht/qxGE.png)
2015-08-08 23:39:55 +00:00
## 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
2015-08-10 01:22:14 +00:00
[See "i3 feature support"](https://github.com/SirCmpwn/sway/issues/2)
2015-08-08 23:39:55 +00:00
2015-08-16 14:21:04 +00:00
## Installation
2015-08-18 20:16:13 +00:00
### From Packages
sway is not supported by many distributions yet. Here's a list of packages
available for you to install:
2015-08-16 14:21:04 +00:00
2015-08-18 20:16:13 +00:00
* [Arch Linux](https://aur.archlinux.org/packages/sway-git/).
2015-08-16 14:21:04 +00:00
2015-08-18 20:16:13 +00:00
### Compiling from Source
2015-08-08 23:39:55 +00:00
2015-08-18 20:16:13 +00:00
Install dependencies:
2015-08-08 23:39:55 +00:00
* cmake
* [wlc](https://github.com/Cloudef/wlc)
2015-08-16 14:04:51 +00:00
* xwayland
2015-08-18 01:27:52 +00:00
* asciidoc
2015-09-01 08:15:09 +00:00
* pcre
* json-c
2015-08-18 20:16:13 +00:00
Run these commands:
2015-08-16 14:07:56 +00:00
2015-08-08 23:39:55 +00:00
cmake .
make
2015-08-18 20:16:13 +00:00
sudo make install
2015-08-08 23:39:55 +00:00
## Configuration
2015-08-18 20:16:13 +00:00
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.
2015-08-08 23:39:55 +00:00
## Running
2015-08-18 20:16:13 +00:00
Run this from a tty (instead of starting x):
2015-08-08 23:39:55 +00:00
sway
2015-08-18 20:16:13 +00:00
If you run it from within x, it will spawn x windows instead of using your
hardware directly (useful for development).