aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 15 insertions, 25 deletions
diff --git a/README.md b/README.md
index 0e92f78e..30911765 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,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) 1# sway
2 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--) - [Українська](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--) - 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--) - [Українська](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--) 4[Русский](https://github.com/swaywm/sway/blob/master/README.ru.md#sway--)
@@ -9,21 +9,13 @@ Read the [FAQ](https://github.com/swaywm/sway/wiki). Join the
9[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
10irc.freenode.net). 10irc.freenode.net).
11 11
12**Notice**: Sway is currently *frozen* and no new features are being shipped 12**Notice**: You are viewing the **unstable** and **unsupported** master branch
13until we finish integrating Sway and wlroots. Bug fixes are still going out. 13of sway, where work is ongoing to port it to
14for more information, [see this 14[wlroots](https://github.com/swaywm/wlroots). The supported branch is the 0.15
15article](https://drewdevault.com/2017/10/09/Future-of-sway.html). To follow 15branch, and end users are encouraged to use the stable releases cut from it.
16wlroots integration status, [see this
17ticket](https://github.com/swaywm/sway/issues/1390).
18 16
19[![](https://sr.ht/ICd5.png)](https://sr.ht/ICd5.png) 17If you'd like to support sway development, please contribute to [SirCmpwn's
20 18Patreon page](https://patreon.com/sircmpwn).
21If you'd like to support Sway development, you can contribute to [SirCmpwn's
22Patreon page](https://patreon.com/sircmpwn) or you can contribute to
23[bounties](https://github.com/swaywm/sway/issues/986) for specific features.
24Anyone is welcome to claim a bounty and you can make a bounty for any feature
25you wish, and Patreon is more useful for supporting the overall health and
26maintenance of Sway.
27 19
28## Release Signatures 20## Release Signatures
29 21
@@ -46,22 +38,22 @@ Sway is available in many distributions. Try installing the "sway" package for
46yours. If it's not available, check out [this wiki page](https://github.com/swaywm/sway/wiki/Unsupported-packages) 38yours. If it's not available, check out [this wiki page](https://github.com/swaywm/sway/wiki/Unsupported-packages)
47for information on installation for your distributions. 39for information on installation for your distributions.
48 40
49If you're interested in packaging Sway for your distribution, stop by the IRC 41If you're interested in packaging sway for your distribution, stop by the IRC
50channel or shoot an email to sir@cmpwn.com for advice. 42channel or shoot an email to sir@cmpwn.com for advice.
51 43
52### Compiling from Source 44### Compiling from Source
53 45
54Install dependencies: 46Install dependencies:
55 47
56* cmake 48* meson
57* [wlc](https://github.com/Cloudef/wlc) 49* [wlroots](https://github.com/swaywm/wlroots)
58* wayland 50* wayland
59* xwayland 51* xwayland
60* libinput >= 1.6.0 52* libinput >= 1.6.0
61* libcap 53* libcap
62* asciidoc 54* asciidoc
63* pcre 55* pcre
64* json-c <= 0.12.1 56* json-c >= 0.13
65* pango 57* pango
66* cairo 58* cairo
67* gdk-pixbuf2 * 59* gdk-pixbuf2 *
@@ -78,11 +70,9 @@ _\*\*\*Only required for tray support_
78 70
79Run these commands: 71Run these commands:
80 72
81 mkdir build 73 meson build
82 cd build 74 ninja -C build
83 cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_SYSCONFDIR=/etc .. 75 sudo ninja -C build install
84 make
85 sudo make install
86 76
87On 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:
88 78
@@ -102,4 +92,4 @@ Run `man 5 sway` for information on the configuration.
102## Running 92## Running
103 93
104Run `sway` from a TTY. Some display managers may work but are not supported by 94Run `sway` from a TTY. Some display managers may work but are not supported by
105Sway (gdm is known to work fairly well). 95sway (gdm is known to work fairly well).