alex/swayfx
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Improve README

Browse source
This commit is contained in:
Drew DeVault 2015-08-18 16:16:13 -04:00
parent 62a21d9d4d
commit be871731e1
1 changed files with 19 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
README.md
View file

@ -1,14 +1,12 @@
# sway # sway
"**S**irCmpwn's **Way**land window manager" "**S**irCmpwn's **Way**land window manager" is a **work in progress**
i3-compatible window manager for [Wayland](http://wayland.freedesktop.org/).
sway is a **work in progress** i3-compatible window manager for [FAQ & wiki](https://github.com/SirCmpwn/sway/wiki)
[Wayland](http://wayland.freedesktop.org/).
![](https://sr.ht/qxGE.png) ![](https://sr.ht/qxGE.png)
Chat on #sway on irc.freenode.net
## Rationale ## Rationale
I use i3 on xorg. Wayland is coming, and [i3way](http://i3way.org/) still has I use i3 on xorg. Wayland is coming, and [i3way](http://i3way.org/) still has
@ -20,44 +18,39 @@ zero lines of source code after two years.
## Installation ## Installation
### Arch Linux ### From Packages
Install [aur/sway-git](https://aur.archlinux.org/packages/sway-git/). sway is not supported by many distributions yet. Here's a list of packages
available for you to install:
### Manual * [Arch Linux](https://aur.archlinux.org/packages/sway-git/).
Dependencies: ### Compiling from Source
Install dependencies:
* cmake * cmake
* [wlc](https://github.com/Cloudef/wlc) * [wlc](https://github.com/Cloudef/wlc)
* xwayland * xwayland
* asciidoc * asciidoc
Compiling: Run these commands:
cmake . cmake .
make make
# sudo make install sudo make install
Binary shows up in `./bin` (or `/usr/local/bin` if you `make install`).
## Configuration ## Configuration
mkdir ~/.config/sway If you already use i3, then copy your i3 config to `~/.config/sway/config` and
cp ~/.config/i3/config ~/.config/sway/ 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.
Or if you don't already use i3:
mkdir ~/.config/sway
cp /etc/sway/config ~/.config/sway/
Edit to your liking.
[See also](http://i3wm.org/docs/)
## Running ## Running
Run this from a tty (instead of starting x):
sway sway
If you run this while xorg is running, it'll run inside of an x window (useful If you run it from within x, it will spawn x windows instead of using your
for testing). Otherwise, it'll run wayland properly. hardware directly (useful for development).