diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 38 |
1 files changed, 18 insertions, 20 deletions
@@ -1,16 +1,19 @@ -# sway [](https://travis-ci.org/SirCmpwn/sway) [](https://drewdevault.com/donate?project=4) +# sway [](https://travis-ci.org/swaywm/sway) [](https://drewdevault.com/donate?project=4) + +[**English**](https://github.com/swaywm/sway/blob/master/README.md#sway--) - [日本語](https://github.com/swaywm/sway/blob/master/README.ja.md#sway--) - [Deutsch](https://github.com/swaywm/sway/blob/master/README.de.md#sway--) - [Ελληνικά](https://github.com/swaywm/sway/blob/master/README.el.md#sway--) - [Français](https://github.com/swaywm/sway/blob/master/README.fr.md#sway--) - [Español](https://github.com/swaywm/sway/blob/master/README.es.md#sway--) - [Українська](https://github.com/swaywm/sway/blob/master/README.uk.md#sway--) - [Italiano](https://github.com/swaywm/sway/blob/master/README.it.md#sway--) - [Português](https://github.com/swaywm/sway/blob/master/README.pt.md#sway--) - +[Русский](https://github.com/swaywm/sway/blob/master/README.ru.md#sway--) "**S**irCmpwn's **Way**land compositor" is a **work in progress** i3-compatible [Wayland](http://wayland.freedesktop.org/) compositor. -Read the [FAQ](https://github.com/SirCmpwn/sway/wiki). Join the +Read the [FAQ](https://github.com/swaywm/sway/wiki). Join the [IRC channel](http://webchat.freenode.net/?channels=sway&uio=d4) (#sway on irc.freenode.net). [](https://sr.ht/ICd5.png) -If you'd like to support Sway development, you can contribute to [my Patreon -page](https://patreon.com/sircmpwn) or you can contribute to -[bounties](https://github.com/SirCmpwn/sway/issues/986) for specific features. +If you'd like to support Sway development, you can contribute to [SirCmpwn's +Patreon page](https://patreon.com/sircmpwn) or you can contribute to +[bounties](https://github.com/swaywm/sway/issues/986) for specific features. Anyone is welcome to claim a bounty and you can make a bounty for any feature you wish, and Patreon is more useful for supporting the overall health and maintenance of Sway. @@ -18,22 +21,22 @@ maintenance of Sway. ## Release Signatures Releases are signed with [B22DA89A](http://pgp.mit.edu/pks/lookup?op=vindex&search=0x52CB6609B22DA89A) -and published [on GitHub](https://github.com/SirCmpwn/sway/releases). +and published [on GitHub](https://github.com/swaywm/sway/releases). ## Status -- [i3 feature support](https://github.com/SirCmpwn/sway/issues/2) -- [IPC feature support](https://github.com/SirCmpwn/sway/issues/98) -- [i3bar feature support](https://github.com/SirCmpwn/sway/issues/343) -- [i3-gaps feature support](https://github.com/SirCmpwn/sway/issues/307) -- [security features](https://github.com/SirCmpwn/sway/issues/984) +- [i3 feature support](https://github.com/swaywm/sway/issues/2) +- [IPC feature support](https://github.com/swaywm/sway/issues/98) +- [i3bar feature support](https://github.com/swaywm/sway/issues/343) +- [i3-gaps feature support](https://github.com/swaywm/sway/issues/307) +- [security features](https://github.com/swaywm/sway/issues/984) ## Installation ### From Packages Sway is available in many distributions. Try installing the "sway" package for -yours. If it's not available, check out [this wiki page](https://github.com/SirCmpwn/sway/wiki/Unsupported-packages) +yours. If it's not available, check out [this wiki page](https://github.com/swaywm/sway/wiki/Unsupported-packages) for information on installation for your distributions. If you're interested in packaging Sway for your distribution, stop by the IRC @@ -73,8 +76,7 @@ Run these commands: On systems with logind, you need to set a few caps on the binary: - sudo setcap cap_sys_ptrace=eip /usr/local/bin/sway - sudo setcap cap_sys_tty_config=eip /usr/local/bin/sway + sudo setcap "cap_sys_ptrace,cap_sys_tty_config=eip" /usr/bin/sway On systems without logind, you need to suid the sway binary: @@ -87,11 +89,7 @@ it'll work out of the box. Otherwise, copy the sample configuration file to `~/.config/sway/config`. It is usually located at `/etc/sway/config`. Run `man 5 sway` for information on the configuration. -My own dotfiles are available [here](https://git.sr.ht/~sircmpwn/dotfiles) if -you want some inspiration, and definitely check out the -[wiki](https://github.com/SirCmpwn/sway/wiki) as well. - ## Running -Instead of running `startx`, run `sway`. You can run `sway` from within X as -well, which is useful for testing. +Run `sway` from a TTY. Some display managers may work but are not supported by +Sway (gdm is known to work fairly well). |