aboutsummaryrefslogtreecommitdiff
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 @@
-# 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)
+# sway
[**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--) -
[Русский](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
[IRC channel](http://webchat.freenode.net/?channels=sway&uio=d4) (#sway on
irc.freenode.net).
-**Notice**: Sway is currently *frozen* and no new features are being shipped
-until we finish integrating Sway and wlroots. Bug fixes are still going out.
-for more information, [see this
-article](https://drewdevault.com/2017/10/09/Future-of-sway.html). To follow
-wlroots integration status, [see this
-ticket](https://github.com/swaywm/sway/issues/1390).
+**Notice**: You are viewing the **unstable** and **unsupported** master branch
+of sway, where work is ongoing to port it to
+[wlroots](https://github.com/swaywm/wlroots). The supported branch is the 0.15
+branch, and end users are encouraged to use the stable releases cut from it.
-[![](https://sr.ht/ICd5.png)](https://sr.ht/ICd5.png)
-
-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.
+If you'd like to support sway development, please contribute to [SirCmpwn's
+Patreon page](https://patreon.com/sircmpwn).
## Release Signatures
@@ -46,22 +38,22 @@ 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/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
+If you're interested in packaging sway for your distribution, stop by the IRC
channel or shoot an email to sir@cmpwn.com for advice.
### Compiling from Source
Install dependencies:
-* cmake
-* [wlc](https://github.com/Cloudef/wlc)
+* meson
+* [wlroots](https://github.com/swaywm/wlroots)
* wayland
* xwayland
* libinput >= 1.6.0
* libcap
* asciidoc
* pcre
-* json-c <= 0.12.1
+* json-c >= 0.13
* pango
* cairo
* gdk-pixbuf2 *
@@ -78,11 +70,9 @@ _\*\*\*Only required for tray support_
Run these commands:
- mkdir build
- cd build
- cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_SYSCONFDIR=/etc ..
- make
- sudo make install
+ meson build
+ ninja -C build
+ sudo ninja -C build install
On systems with logind, you need to set a few caps on the binary:
@@ -102,4 +92,4 @@ Run `man 5 sway` for information on the configuration.
## Running
Run `sway` from a TTY. Some display managers may work but are not supported by
-Sway (gdm is known to work fairly well).
+sway (gdm is known to work fairly well).