mirrors/sway
1
0
Fork 0
mirror of https://github.com/swaywm/sway.git synced 2024-11-01 05:57:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
sway/README.md
Drew DeVault 46fbb413f2 Mention Patreon in README.md 
Does this make me a sellout
2017-05-11 11:47:42 -04:00

3.3 KiB
Raw Blame History

sway Donate with fosspay

"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 my 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

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.

My own dotfiles are available here if you want some inspiration, and definitely check out the wiki as well.

Running

Instead of running startx, run sway. You can run sway from within X as well, which is useful for testing.