summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 18 insertions, 20 deletions
diff --git a/README.md b/README.md
index 65a943d3..e1bf9590 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,19 @@
1# 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) 1# sway [![](https://api.travis-ci.org/swaywm/sway.svg)](https://travis-ci.org/swaywm/sway) [![Donate with fosspay](https://drewdevault.com/donate/static/donate-with-fosspay.png)](https://drewdevault.com/donate?project=4)
2
3[**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--) -
4[Русский](https://github.com/swaywm/sway/blob/master/README.ru.md#sway--)
2 5
3"**S**irCmpwn's **Way**land compositor" is a **work in progress** 6"**S**irCmpwn's **Way**land compositor" is a **work in progress**
4i3-compatible [Wayland](http://wayland.freedesktop.org/) compositor. 7i3-compatible [Wayland](http://wayland.freedesktop.org/) compositor.
5Read the [FAQ](https://github.com/SirCmpwn/sway/wiki). Join the 8Read the [FAQ](https://github.com/swaywm/sway/wiki). Join the
6[IRC channel](http://webchat.freenode.net/?channels=sway&uio=d4) (#sway on 9[IRC channel](http://webchat.freenode.net/?channels=sway&uio=d4) (#sway on
7irc.freenode.net). 10irc.freenode.net).
8 11
9[![](https://sr.ht/ICd5.png)](https://sr.ht/ICd5.png) 12[![](https://sr.ht/ICd5.png)](https://sr.ht/ICd5.png)
10 13
11If you'd like to support Sway development, you can contribute to [my Patreon 14If you'd like to support Sway development, you can contribute to [SirCmpwn's
12page](https://patreon.com/sircmpwn) or you can contribute to 15Patreon page](https://patreon.com/sircmpwn) or you can contribute to
13[bounties](https://github.com/SirCmpwn/sway/issues/986) for specific features. 16[bounties](https://github.com/swaywm/sway/issues/986) for specific features.
14Anyone is welcome to claim a bounty and you can make a bounty for any feature 17Anyone is welcome to claim a bounty and you can make a bounty for any feature
15you wish, and Patreon is more useful for supporting the overall health and 18you wish, and Patreon is more useful for supporting the overall health and
16maintenance of Sway. 19maintenance of Sway.
@@ -18,22 +21,22 @@ maintenance of Sway.
18## Release Signatures 21## Release Signatures
19 22
20Releases are signed with [B22DA89A](http://pgp.mit.edu/pks/lookup?op=vindex&search=0x52CB6609B22DA89A) 23Releases are signed with [B22DA89A](http://pgp.mit.edu/pks/lookup?op=vindex&search=0x52CB6609B22DA89A)
21and published [on GitHub](https://github.com/SirCmpwn/sway/releases). 24and published [on GitHub](https://github.com/swaywm/sway/releases).
22 25
23## Status 26## Status
24 27
25- [i3 feature support](https://github.com/SirCmpwn/sway/issues/2) 28- [i3 feature support](https://github.com/swaywm/sway/issues/2)
26- [IPC feature support](https://github.com/SirCmpwn/sway/issues/98) 29- [IPC feature support](https://github.com/swaywm/sway/issues/98)
27- [i3bar feature support](https://github.com/SirCmpwn/sway/issues/343) 30- [i3bar feature support](https://github.com/swaywm/sway/issues/343)
28- [i3-gaps feature support](https://github.com/SirCmpwn/sway/issues/307) 31- [i3-gaps feature support](https://github.com/swaywm/sway/issues/307)
29- [security features](https://github.com/SirCmpwn/sway/issues/984) 32- [security features](https://github.com/swaywm/sway/issues/984)
30 33
31## Installation 34## Installation
32 35
33### From Packages 36### From Packages
34 37
35Sway is available in many distributions. Try installing the "sway" package for 38Sway is available in many distributions. Try installing the "sway" package for
36yours. If it's not available, check out [this wiki page](https://github.com/SirCmpwn/sway/wiki/Unsupported-packages) 39yours. If it's not available, check out [this wiki page](https://github.com/swaywm/sway/wiki/Unsupported-packages)
37for information on installation for your distributions. 40for information on installation for your distributions.
38 41
39If you're interested in packaging Sway for your distribution, stop by the IRC 42If you're interested in packaging Sway for your distribution, stop by the IRC
@@ -73,8 +76,7 @@ Run these commands:
73 76
74On systems with logind, you need to set a few caps on the binary: 77On systems with logind, you need to set a few caps on the binary:
75 78
76 sudo setcap cap_sys_ptrace=eip /usr/local/bin/sway 79 sudo setcap "cap_sys_ptrace,cap_sys_tty_config=eip" /usr/bin/sway
77 sudo setcap cap_sys_tty_config=eip /usr/local/bin/sway
78 80
79On systems without logind, you need to suid the sway binary: 81On systems without logind, you need to suid the sway binary:
80 82
@@ -87,11 +89,7 @@ it'll work out of the box. Otherwise, copy the sample configuration file to
87`~/.config/sway/config`. It is usually located at `/etc/sway/config`. 89`~/.config/sway/config`. It is usually located at `/etc/sway/config`.
88Run `man 5 sway` for information on the configuration. 90Run `man 5 sway` for information on the configuration.
89 91
90My own dotfiles are available [here](https://git.sr.ht/~sircmpwn/dotfiles) if
91you want some inspiration, and definitely check out the
92[wiki](https://github.com/SirCmpwn/sway/wiki) as well.
93
94## Running 92## Running
95 93
96Instead of running `startx`, run `sway`. You can run `sway` from within X as 94Run `sway` from a TTY. Some display managers may work but are not supported by
97well, which is useful for testing. 95Sway (gdm is known to work fairly well).