i3-compatible Wayland compositor
Go to file
Philz69 c3d7036867 Updated the french readme (#3964)
* Updated the french readme

Removed the image at the start of the readme.
Removed the mention of bounties.
Updated the dependencies.
Removed a few lines that were not present in the english readme anymore.

* Fix errors.

Fixed capitalisation.
Changed "root" to italics.
2019-03-24 21:19:13 +02:00
.builds ci: use scdoc-git because 1.9.1 is broken 2019-03-01 12:32:00 -07:00
assets Recompressed PNG files 2017-01-05 21:49:28 -05:00
client Fix dead stores found by scan-build 2019-01-22 10:12:04 -05:00
common Add support for manually setting subpixel hinting on outputs. 2019-03-24 09:37:24 +02:00
completions Add missing swaymsg completions 2019-03-08 15:28:35 -05:00
contrib A script to make inactive windows transparent 2018-10-20 21:58:00 +03:00
include Add support for manually setting subpixel hinting on outputs. 2019-03-24 09:37:24 +02:00
protocols Implement pointer-constraints-unstable-v1 2019-01-30 19:53:59 +01:00
security.d delete references to swaygrab 2018-07-30 16:24:46 +01:00
sway Add support for manually setting subpixel hinting on outputs. 2019-03-24 09:37:24 +02:00
swaybar swaybar: fix loading of malformed icon theme 2019-03-13 22:04:04 -06:00
swaybg Removed unused wlroots dependency for sway(bg|bar|msg|nag) 2019-01-21 13:04:15 -05:00
swaymsg Add support for manually setting subpixel hinting on outputs. 2019-03-24 09:37:24 +02:00
swaynag Repair swaynag crash reading message from stdin 2019-03-11 23:00:39 -04:00
.clang-format Update .clang-format - not entirely usable yet 2017-01-10 23:30:34 -05:00
.editorconfig Create .editorconfig 2016-07-04 14:12:32 +02:00
.gitignore Allocate minimum size necessary in pango text functions. (#3473) 2019-01-20 15:03:30 +01:00
CONTRIBUTING.md CONTRIBUTING.md: mention tab width for line length 2019-01-14 19:46:54 +01:00
ISSUE_TEMPLATE.md issue template: add instructions for stack traces 2018-12-17 18:38:15 +01:00
LICENSE MIT license 2017-01-06 13:45:48 -05:00
README.bg.md Split swaylock into separate project 2019-01-13 21:40:26 -05:00
README.de.md Split swaylock into separate project 2019-01-13 21:40:26 -05:00
README.el.md Split swaylock into separate project 2019-01-13 21:40:26 -05:00
README.es.md meson: update scdoc requirement to >= 1.9.2 2019-03-04 08:44:17 -07:00
README.fr.md Updated the french readme (#3964) 2019-03-24 21:19:13 +02:00
README.it.md Split swaylock into separate project 2019-01-13 21:40:26 -05:00
README.ja.md Merge pull request #3417 from swaywm/remove-swaylock 2019-01-14 08:57:20 +01:00
README.md meson: update scdoc requirement to >= 1.9.2 2019-03-04 08:44:17 -07:00
README.pl.md meson: update scdoc requirement to >= 1.9.2 2019-03-04 08:44:17 -07:00
README.pt.md Split swaylock into separate project 2019-01-13 21:40:26 -05:00
README.ru.md Split swaylock into separate project 2019-01-13 21:40:26 -05:00
README.uk.md Split swaylock into separate project 2019-01-13 21:40:26 -05:00
config.in config.in: allow launch apps with args via dmenu 2019-03-12 08:16:45 -06:00
meson.build meson: use pkg-config var for scdoc path 2019-03-10 18:18:08 -04:00
meson_options.txt Set version in project file 2019-02-05 14:32:05 +01:00
sway.desktop Update language in sway.desktop & sway(1) 2019-03-10 15:09:52 -04:00

README.md

sway

English - 日本語 - Deutsch - Ελληνικά - Français - Українська - Italiano - Português - Русский - Български - Español - Polski

sway is an i3-compatible Wayland compositor. Read the FAQ. Join the IRC channel (#sway on irc.freenode.net).

If you'd like to support sway development, please contribute to SirCmpwn's Patreon page.

Release Signatures

Releases are signed with B22DA89A and published on GitHub.

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 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
  • wayland
  • wayland-protocols *
  • pcre
  • json-c
  • pango
  • cairo
  • gdk-pixbuf2 **
  • 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).