Add readme

This commit is contained in:
Drew DeVault 2015-08-08 19:39:55 -04:00
parent a78b921803
commit f2b9fd6f39

47
README.md Normal file
View file

@ -0,0 +1,47 @@
# sway
"**S**irCmpwn's **Way**land window manager"
sway is an i3-compatible window manager for
[Wayland](http://wayland.freedesktop.org/).
![](https://sr.ht/7DsT.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
Not really usable yet.
## Compile / Install
Dependencies:
* cmake
* [wlc](https://github.com/Cloudef/wlc)
* xkb
Notably missing: weston is not required.
cmake .
make
# sudo make install
Binary shows up in `./bin` (or `/usr/bin` if you `make install`).
## Configuration
mkdir ~/.sway
cp ~/.i3/config ~/.sway/config
[See also](http://i3wm.org/docs/)
## Running
sway
If you run this while xorg is running, it'll run inside of an x window (useful
for testing). Otherwise, it'll run wayland properly.