b24eb08f59
Adds links for the yet to-be-merged Greek, French and Spanish versions of README.md to the existing language list. |
||
|---|---|---|
| assets | ||
| CMake | ||
| common | ||
| completions/zsh | ||
| contrib | ||
| include | ||
| protocols | ||
| security.d | ||
| sway | ||
| swaybar | ||
| swaybg | ||
| swaygrab | ||
| swaylock | ||
| swaymsg | ||
| wayland | ||
| .build.yml | ||
| .clang-format | ||
| .editorconfig | ||
| .gitignore | ||
| .travis.yml | ||
| CMakeLists.txt | ||
| config.in | ||
| CONTRIBUTING.md | ||
| HACKING.md | ||
| LICENSE | ||
| README.de.md | ||
| README.el.md | ||
| README.ja.md | ||
| README.md | ||
| sway.desktop | ||
sway 
English - 日本語 - Deutsch - Ελληνικά - Français - Español
"SirCmpwn's Wayland compositor" is a work in progress i3-compatible Wayland compositor. Read the FAQ. Join the IRC channel (#sway on irc.freenode.net).
If you'd like to support Sway development, you can contribute to SirCmpwn's Patreon page or you can contribute to bounties 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.
Release Signatures
Releases are signed with B22DA89A and published on GitHub.
Status
- i3 feature support
- IPC feature support
- i3bar feature support
- i3-gaps feature support
- security features
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:
- cmake
- wlc
- wayland
- xwayland
- libinput >= 1.6.0
- libcap
- asciidoc
- pcre
- json-c
- pango
- cairo
- gdk-pixbuf2 *
- pam **
- imagemagick (required for image capture with swaygrab)
- ffmpeg (required for video capture with swaygrab)
*Only required for swaybar, swaybg, and swaylock
**Only required for swaylock
Run these commands:
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_SYSCONFDIR=/etc ..
make
sudo make install
On systems with logind, you need to set a few caps on the binary:
sudo setcap cap_sys_ptrace=eip /usr/local/bin/sway
sudo setcap cap_sys_tty_config=eip /usr/local/bin/sway
On systems without logind, you need to suid the sway binary:
sudo chmod a+s /usr/local/bin/sway
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).