3f184cf188
Since scdoc 1.9.1 is bugged, this updates the meson version check to >= 1.9.2 and drops the version requirement from the README. This should make it more obvious to users who have 1.9.1 that they need to update scdoc to be able to compile man pages and hopefully cut down on the duplicate issues
74 lines
2.9 KiB
Markdown
74 lines
2.9 KiB
Markdown
# 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--) - [Български](https://github.com/swaywm/sway/blob/master/README.bg.md#sway--) - [Español](https://github.com/swaywm/sway/blob/master/README.es.md#sway--) -
|
|
[Polski](https://github.com/swaywm/sway/blob/master/README.pl.md#sway--)
|
|
|
|
sway is an i3-compatible [Wayland](http://wayland.freedesktop.org/) compositor.
|
|
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).
|
|
|
|
If you'd like to support sway development, please contribute to [SirCmpwn's
|
|
Patreon page](https://patreon.com/sircmpwn).
|
|
|
|
## Release Signatures
|
|
|
|
Releases are signed with [B22DA89A](http://pgp.mit.edu/pks/lookup?op=vindex&search=0x52CB6609B22DA89A)
|
|
and published [on GitHub](https://github.com/swaywm/sway/releases).
|
|
|
|
## 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/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
|
|
channel or shoot an email to sir@cmpwn.com for advice.
|
|
|
|
### Compiling from Source
|
|
|
|
Install dependencies:
|
|
|
|
* meson \*
|
|
* [wlroots](https://github.com/swaywm/wlroots)
|
|
* wayland
|
|
* wayland-protocols \*
|
|
* pcre
|
|
* json-c
|
|
* pango
|
|
* cairo
|
|
* gdk-pixbuf2 \*\*
|
|
* [scdoc](https://git.sr.ht/~sircmpwn/scdoc) (optional: man pages) \*
|
|
* git \*
|
|
|
|
_\*Compile-time dep_
|
|
|
|
_\*\*optional: required for swaybg_
|
|
|
|
Run these commands:
|
|
|
|
meson build
|
|
ninja -C build
|
|
sudo ninja -C build install
|
|
|
|
On systems without logind, you need to suid the sway binary:
|
|
|
|
sudo chmod a+s /usr/local/bin/sway
|
|
|
|
Sway will drop root permissions shortly after startup.
|
|
|
|
## Configuration
|
|
|
|
If you already use i3, then copy your i3 config to `~/.config/sway/config` and
|
|
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.
|
|
|
|
## Running
|
|
|
|
Run `sway` from a TTY. Some display managers may work but are not supported by
|
|
sway (gdm is known to work fairly well).
|