sway/README.md

# sway

**[English][en]** - [عربي][ar] - [Česky][cs] - [Deutsch][de] - [Dansk][dk] - [Español][es] - [Français][fr] - [ქართული][ge] - [Ελληνικά][gr] - [हिन्दी][hi] - [Magyar][hu] - [فارسی][ir] - [Italiano][it] - [日本語][ja] - [한국어][ko] - [Nederlands][nl] - [Norsk][no] - [Polski][pl] - [Português][pt] - [Română][ro] - [Русский][ru] - [Svenska][sv] - [Türkçe][tr] - [Українська][uk] - [中文-简体][zh-CN] - [中文-繁體][zh-TW]

sway is an [i3]-compatible [Wayland] compositor. Read the [FAQ]. Join the
[IRC channel] \(#sway on irc.libera.chat).

## Release Signatures

Releases are signed with [E88F5E48] and published [on GitHub][GitHub releases].

## Installation

### From Packages

Sway is available in many distributions. Try installing the "sway" package for
yours.

### Compiling from Source

Check out [this wiki page][Development setup] if you want to build the HEAD of
sway and wlroots for testing or development.

Install dependencies:

* meson \*
* [wlroots]
* wayland
* wayland-protocols \*
* pcre2
* json-c
* pango
* cairo
* gdk-pixbuf2 (optional: additional image formats for system tray)
* [swaybg] (optional: wallpaper)
* [scdoc] (optional: man pages) \*
* git (optional: version info) \*

_\* Compile-time dep_

Run these commands:

    meson build/
    ninja -C build/
    sudo ninja -C build/ install

## 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).

[en]: https://github.com/swaywm/sway#readme
[ar]: README.ar.md
[cs]: README.cs.md
[de]: README.de.md
[dk]: README.dk.md
[es]: README.es.md
[fr]: README.fr.md
[ge]: README.ge.md
[gr]: README.gr.md
[hi]: README.hi.md
[hu]: README.hu.md
[ir]: README.ir.md
[it]: README.it.md
[ja]: README.ja.md
[ko]: README.ko.md
[nl]: README.nl.md
[no]: README.no.md
[pl]: README.pl.md
[pt]: README.pt.md
[ro]: README.ro.md
[ru]: README.ru.md
[sv]: README.sv.md
[tr]: README.tr.md
[uk]: README.uk.md
[zh-CN]: README.zh-CN.md
[zh-TW]: README.zh-TW.md
[i3]: https://i3wm.org/
[Wayland]: http://wayland.freedesktop.org/
[FAQ]: https://github.com/swaywm/sway/wiki
[IRC channel]: https://web.libera.chat/gamja/?channels=#sway
[E88F5E48]: https://keys.openpgp.org/search?q=34FF9526CFEF0E97A340E2E40FDE7BE0E88F5E48
[GitHub releases]: https://github.com/swaywm/sway/releases
[Development setup]: https://github.com/swaywm/sway/wiki/Development-Setup
[wlroots]: https://gitlab.freedesktop.org/wlroots/wlroots
[swaybg]: https://github.com/swaywm/swaybg/
[scdoc]: https://git.sr.ht/~sircmpwn/scdoc
Drop Travis in favor of builds.sr.ht 2018-03-04 21:37:48 +00:00			`# sway`
Add readme 2015-08-08 23:39:55 +00:00
Translate README to Arabic 2023-09-14 08:42:09 +00:00			[English][en] - [عربي][ar] - [Česky][cs] - [Deutsch][de] - [Dansk][dk] - [Español][es] - [Français][fr] - [ქართული][ge] - [Ελληνικά][gr] - [हिन्दी][hi] - [Magyar][hu] - [فارسی][ir] - [Italiano][it] - [日本語][ja] - [한국어][ko] - [Nederlands][nl] - [Norsk][no] - [Polski][pl] - [Português][pt] - [Română][ro] - [Русский][ru] - [Svenska][sv] - [Türkçe][tr] - [Українська][uk] - [中文-简体][zh-CN] - [中文-繁體][zh-TW]
Translate README to Japanese / READMEを日本語訳す 2017-08-13 18:01:55 +00:00
readme: use references for links This avoids cluttering the README text with URLs. 2020-12-18 10:31:04 +00:00			`sway is an [i3]-compatible [Wayland] compositor. Read the [FAQ]. Join the`
Fix IRC links in READMEs and templates Change the webchat links from freenode.net to point to the new destination libera.chat. Co-authored-by: Simon Ser <contact@emersion.fr> 2021-05-21 14:09:49 +00:00			`[IRC channel] \(#sway on irc.libera.chat).`
Add readme 2015-08-08 23:39:55 +00:00
Update README 2016-03-24 18:24:43 +00:00			`## Release Signatures`
Add readme 2015-08-08 23:39:55 +00:00
readme: use references for links This avoids cluttering the README text with URLs. 2020-12-18 10:31:04 +00:00			`Releases are signed with [E88F5E48] and published [on GitHub][GitHub releases].`
Add readme 2015-08-08 23:39:55 +00:00
Mention aur package in readme 2015-08-16 14:21:04 +00:00			`## Installation`

Improve README 2015-08-18 20:16:13 +00:00			`### From Packages`

Edit packages in README 2017-02-23 13:33:24 +00:00			`Sway is available in many distributions. Try installing the "sway" package for`
readme: remove link to non-existing wiki page 2020-12-18 10:12:14 +00:00			`yours.`
Mention aur package in readme 2015-08-16 14:21:04 +00:00
Improve README 2015-08-18 20:16:13 +00:00			`### Compiling from Source`
Add readme 2015-08-08 23:39:55 +00:00
readme: use references for links This avoids cluttering the README text with URLs. 2020-12-18 10:31:04 +00:00			`Check out [this wiki page][Development setup] if you want to build the HEAD of`
			`sway and wlroots for testing or development.`
readme: link to the development doc The subproject compilation is the best way to test sway and wlroots but it's hidden. I only found it from comments in issues. 2020-06-04 13:27:49 +00:00
Improve README 2015-08-18 20:16:13 +00:00			`Install dependencies:`
Add readme 2015-08-08 23:39:55 +00:00
Clean up dependencies in README.md 2018-11-02 17:47:33 +00:00			`* meson \*`
readme: use references for links This avoids cluttering the README text with URLs. 2020-12-18 10:31:04 +00:00			`* [wlroots]`
Add new dependencies for wayland clients Cairo for rendering shit, Pango for text rendering, and wayland client stuff. Thanks @Cloudef, blatantly ripping off his cmake files for this 2015-11-12 13:17:52 +00:00			`* wayland`
Clean up dependencies in README.md 2018-11-02 17:47:33 +00:00			`* wayland-protocols \*`
Replace pcre with pcre2 Closes: https://github.com/swaywm/sway/issues/6838 2022-03-12 13:02:32 +00:00			`* pcre2`
Clean up dependencies in README.md 2018-11-02 17:47:33 +00:00			`* json-c`
Set Cairo and Pango as required dependencies 2016-05-14 19:18:44 +00:00			`* pango`
			`* cairo`
Clarify gdk-pixbuf dependency purpose swaybg is out-of-tree so not relevant here. swaybar's tray doesn't actually depend on gdk-pixbuf, but gdk-pixbuf enables more image formats for swaybar tray when available. Closes: https://github.com/swaywm/sway/issues/7913 2024-01-19 11:21:15 +00:00			`* gdk-pixbuf2 (optional: additional image formats for system tray)`
readme: add swaybg as optional dep 2023-12-04 15:35:59 +00:00			`* [swaybg] (optional: wallpaper)`
readme: use references for links This avoids cluttering the README text with URLs. 2020-12-18 10:31:04 +00:00			`* [scdoc] (optional: man pages) \*`
readme: git is an optional dependency 2020-03-12 12:13:23 +00:00			`* git (optional: version info) \*`
Make some dependencies optional Closes #368 2015-12-20 14:14:30 +00:00
readme: add missing space 2021-09-28 19:01:28 +00:00			`_\* Compile-time dep_`
Make some dependencies optional Closes #368 2015-12-20 14:14:30 +00:00
Improve README 2015-08-18 20:16:13 +00:00			`Run these commands:`
Improve readme 2015-08-16 14:07:56 +00:00
readme: make it clearer that meson takes a dir as argument "build" can easily be misinterpreted as a Meson subcommand. 2021-04-03 12:24:53 +00:00			`meson build/`
			`ninja -C build/`
			`sudo ninja -C build/ install`
Update README.md 2017-03-28 11:45:16 +00:00
Add readme 2015-08-08 23:39:55 +00:00			`## Configuration`

Improve README 2015-08-18 20:16:13 +00:00			If you already use i3, then copy your i3 config to `~/.config/sway/config` and
Can customize config fallback directory CMake takes a `FALLBACK_CONFIG_DIR` flag which is the directory where the standard configuration file `config` is copied at installation. If loading from typical configuration directories fails, sway loads FALLBACK_CONFIG_DIR/config (/etc/sway/config by default). 2015-11-30 23:38:23 +00:00			`it'll work out of the box. Otherwise, copy the sample configuration file to`
Use SYSCONFDIR as recommended - swaylock config path not hardcoded anymore - the unusual and weird FALLBACK_CONFIG_DIR is no more 2015-12-23 11:22:48 +00:00			`~/.config/sway/config`. It is usually located at `/etc/sway/config`.
			Run `man 5 sway` for information on the configuration.
Add readme 2015-08-08 23:39:55 +00:00
			`## Running`

Translate README to Japanese / READMEを日本語訳す 2017-08-13 18:01:55 +00:00			Run `sway` from a TTY. Some display managers may work but are not supported by
Add README.md 2018-04-13 00:22:27 +00:00			`sway (gdm is known to work fairly well).`
readme: use references for links This avoids cluttering the README text with URLs. 2020-12-18 10:31:04 +00:00
			`[en]: https://github.com/swaywm/sway#readme`
Translate README to Arabic 2023-09-14 08:42:09 +00:00			`[ar]: README.ar.md`
Translate README to Czech 2022-11-27 16:02:08 +00:00			`[cs]: README.cs.md`
readme: use relative links for translations 2022-02-07 10:04:47 +00:00			`[de]: README.de.md`
			`[dk]: README.dk.md`
			`[es]: README.es.md`
			`[fr]: README.fr.md`
Add Georgian README I am a native Georgian speaker. I have translated sway's README.md 2023-07-19 17:26:53 +00:00			`[ge]: README.ge.md`
readme: use relative links for translations 2022-02-07 10:04:47 +00:00			`[gr]: README.gr.md`
Add a Hindi (हिन्दी) translation to the README Hindi is one of the most prominent languages of the Indian Subcontinent. This commit adds the translation of the README into the Hindi language. Some of the words are still written in English because there wasn't an appropriate technical term of the word in the language. Co-authored-by: Surendrajat <surendrajat@protonmail.com> 2022-05-27 19:09:18 +00:00			`[hi]: README.hi.md`
readme: use relative links for translations 2022-02-07 10:04:47 +00:00			`[hu]: README.hu.md`
			`[ir]: README.ir.md`
			`[it]: README.it.md`
			`[ja]: README.ja.md`
			`[ko]: README.ko.md`
			`[nl]: README.nl.md`
Add Norwegian READMR Added a Norwegian README file `README.no.md` and added a link to it in the original `README.md` file. 2023-02-02 16:45:01 +00:00			`[no]: README.no.md`
readme: use relative links for translations 2022-02-07 10:04:47 +00:00			`[pl]: README.pl.md`
			`[pt]: README.pt.md`
			`[ro]: README.ro.md`
			`[ru]: README.ru.md`
Add Norwegian READMR Added a Norwegian README file `README.no.md` and added a link to it in the original `README.md` file. 2023-02-02 16:45:01 +00:00			`[sv]: README.sv.md`
readme: use relative links for translations 2022-02-07 10:04:47 +00:00			`[tr]: README.tr.md`
			`[uk]: README.uk.md`
			`[zh-CN]: README.zh-CN.md`
			`[zh-TW]: README.zh-TW.md`
readme: use references for links This avoids cluttering the README text with URLs. 2020-12-18 10:31:04 +00:00			`[i3]: https://i3wm.org/`
			`[Wayland]: http://wayland.freedesktop.org/`
			`[FAQ]: https://github.com/swaywm/sway/wiki`
readme: link to gamja for IRC gamja offers a better experience than Kiwi. Obviously I'm 100% biased. Completely fine to not make the switch if someone feels differently. 2021-09-13 06:33:10 +00:00			`[IRC channel]: https://web.libera.chat/gamja/?channels=#sway`
readme: use references for links This avoids cluttering the README text with URLs. 2020-12-18 10:31:04 +00:00			`[E88F5E48]: https://keys.openpgp.org/search?q=34FF9526CFEF0E97A340E2E40FDE7BE0E88F5E48`
			`[GitHub releases]: https://github.com/swaywm/sway/releases`
			`[Development setup]: https://github.com/swaywm/sway/wiki/Development-Setup`
Update URL to wlroots project (GitHub->GitLab) 2021-11-02 03:23:13 +00:00			`[wlroots]: https://gitlab.freedesktop.org/wlroots/wlroots`
readme: add swaybg as optional dep 2023-12-04 15:35:59 +00:00			`[swaybg]: https://github.com/swaywm/swaybg/`
readme: use references for links This avoids cluttering the README text with URLs. 2020-12-18 10:31:04 +00:00			`[scdoc]: https://git.sr.ht/~sircmpwn/scdoc`