diff options
| author | Drew DeVault <ddevault@linode.com> | 2015-08-18 16:16:13 -0400 |
|---|---|---|
| committer | Drew DeVault <ddevault@linode.com> | 2015-08-18 16:16:42 -0400 |
| commit | be871731e127d695d7c79dff185d55be95e20cf5 (patch) | |
| tree | 8119376627e6bc8419bb366a32b0c7939f254fd2 | |
| parent | 62a21d9d4d3041ed7fc4a9140d98cc29fbdb2759 (diff) | |
| download | sway-be871731e127d695d7c79dff185d55be95e20cf5.tar.xz | |
Improve README
| -rw-r--r-- | README.md | 45 |
1 files changed, 19 insertions, 26 deletions
@@ -1,14 +1,12 @@ # 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 -[Wayland](http://wayland.freedesktop.org/). +[FAQ & wiki](https://github.com/SirCmpwn/sway/wiki)  -Chat on #sway on irc.freenode.net - ## Rationale 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 -### Arch Linux +### From Packages + +sway is not supported by many distributions yet. Here's a list of packages +available for you to install: -Install [aur/sway-git](https://aur.archlinux.org/packages/sway-git/). +* [Arch Linux](https://aur.archlinux.org/packages/sway-git/). -### Manual +### Compiling from Source -Dependencies: +Install dependencies: * cmake * [wlc](https://github.com/Cloudef/wlc) * xwayland * asciidoc -Compiling: +Run these commands: cmake . make - # sudo make install - -Binary shows up in `./bin` (or `/usr/local/bin` if you `make install`). + sudo make install ## Configuration - mkdir ~/.config/sway - cp ~/.config/i3/config ~/.config/sway/ - -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/) +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 this while xorg is running, it'll run inside of an x window (useful -for testing). Otherwise, it'll run wayland properly. +If you run it from within x, it will spawn x windows instead of using your +hardware directly (useful for development). |