aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md70
1 files changed, 37 insertions, 33 deletions
diff --git a/README.md b/README.md
index 4698afbe..15c7c099 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
1# sway 1# sway
2 2
3**[English][en]** - [日本語][ja] - [Français][fr] - [Українська][uk] - [Español][es] - [Polski][pl] - [中文-简体][zh-CN] - [Deutsch][de] - [Nederlands][nl] - [Русский][ru] - [中文-繁體][zh-TW] - [Português][pt] - [Danish][dk] - [한국어][ko] - [Română][ro] 3**[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]
4 4
5sway is an [i3]-compatible [Wayland] compositor. Read the [FAQ]. Join the 5sway is an [i3]-compatible [Wayland] compositor. Read the [FAQ]. Join the
6[IRC channel] \(#sway on irc.freenode.net). 6[IRC channel] \(#sway on irc.libera.chat).
7 7
8## Release Signatures 8## Release Signatures
9 9
@@ -16,9 +16,6 @@ Releases are signed with [E88F5E48] and published [on GitHub][GitHub releases].
16Sway is available in many distributions. Try installing the "sway" package for 16Sway is available in many distributions. Try installing the "sway" package for
17yours. 17yours.
18 18
19If you're interested in packaging sway for your distribution, stop by the IRC
20channel or shoot an email to sir@cmpwn.com for advice.
21
22### Compiling from Source 19### Compiling from Source
23 20
24Check out [this wiki page][Development setup] if you want to build the HEAD of 21Check out [this wiki page][Development setup] if you want to build the HEAD of
@@ -30,27 +27,22 @@ Install dependencies:
30* [wlroots] 27* [wlroots]
31* wayland 28* wayland
32* wayland-protocols \* 29* wayland-protocols \*
33* pcre 30* pcre2
34* json-c 31* json-c
35* pango 32* pango
36* cairo 33* cairo
37* gdk-pixbuf2 (optional: system tray) 34* gdk-pixbuf2 (optional: additional image formats for system tray)
35* [swaybg] (optional: wallpaper)
38* [scdoc] (optional: man pages) \* 36* [scdoc] (optional: man pages) \*
39* git (optional: version info) \* 37* git (optional: version info) \*
40 38
41_\*Compile-time dep_ 39_\* Compile-time dep_
42 40
43Run these commands: 41Run these commands:
44 42
45 meson build 43 meson build/
46 ninja -C build 44 ninja -C build/
47 sudo ninja -C build install 45 sudo ninja -C build/ install
48
49On systems without logind, you need to suid the sway binary:
50
51 sudo chmod a+s /usr/local/bin/sway
52
53Sway will drop root permissions shortly after startup.
54 46
55## Configuration 47## Configuration
56 48
@@ -65,26 +57,38 @@ Run `sway` from a TTY. Some display managers may work but are not supported by
65sway (gdm is known to work fairly well). 57sway (gdm is known to work fairly well).
66 58
67[en]: https://github.com/swaywm/sway#readme 59[en]: https://github.com/swaywm/sway#readme
68[ja]: https://github.com/swaywm/sway/blob/master/README.ja.md 60[ar]: README.ar.md
69[fr]: https://github.com/swaywm/sway/blob/master/README.fr.md 61[cs]: README.cs.md
70[uk]: https://github.com/swaywm/sway/blob/master/README.uk.md 62[de]: README.de.md
71[es]: https://github.com/swaywm/sway/blob/master/README.es.md 63[dk]: README.dk.md
72[pl]: https://github.com/swaywm/sway/blob/master/README.pl.md 64[es]: README.es.md
73[zh-CN]: https://github.com/swaywm/sway/blob/master/README.zh-CN.md 65[fr]: README.fr.md
74[de]: https://github.com/swaywm/sway/blob/master/README.de.md 66[ge]: README.ge.md
75[nl]: https://github.com/swaywm/sway/blob/master/README.nl.md 67[gr]: README.gr.md
76[ru]: https://github.com/swaywm/sway/blob/master/README.ru.md 68[hi]: README.hi.md
77[zh-TW]: https://github.com/swaywm/sway/blob/master/README.zh-TW.md 69[hu]: README.hu.md
78[pt]: https://github.com/swaywm/sway/blob/master/README.pt.md 70[ir]: README.ir.md
79[dk]: https://github.com/swaywm/sway/blob/master/README.dk.md 71[it]: README.it.md
80[ko]: https://github.com/swaywm/sway/blob/master/README.ko.md 72[ja]: README.ja.md
81[ro]: https://github.com/swaywm/sway/blob/master/README.ro.md 73[ko]: README.ko.md
74[nl]: README.nl.md
75[no]: README.no.md
76[pl]: README.pl.md
77[pt]: README.pt.md
78[ro]: README.ro.md
79[ru]: README.ru.md
80[sv]: README.sv.md
81[tr]: README.tr.md
82[uk]: README.uk.md
83[zh-CN]: README.zh-CN.md
84[zh-TW]: README.zh-TW.md
82[i3]: https://i3wm.org/ 85[i3]: https://i3wm.org/
83[Wayland]: http://wayland.freedesktop.org/ 86[Wayland]: http://wayland.freedesktop.org/
84[FAQ]: https://github.com/swaywm/sway/wiki 87[FAQ]: https://github.com/swaywm/sway/wiki
85[IRC channel]: http://webchat.freenode.net/?channels=sway&uio=d4 88[IRC channel]: https://web.libera.chat/gamja/?channels=#sway
86[E88F5E48]: https://keys.openpgp.org/search?q=34FF9526CFEF0E97A340E2E40FDE7BE0E88F5E48 89[E88F5E48]: https://keys.openpgp.org/search?q=34FF9526CFEF0E97A340E2E40FDE7BE0E88F5E48
87[GitHub releases]: https://github.com/swaywm/sway/releases 90[GitHub releases]: https://github.com/swaywm/sway/releases
88[Development setup]: https://github.com/swaywm/sway/wiki/Development-Setup 91[Development setup]: https://github.com/swaywm/sway/wiki/Development-Setup
89[wlroots]: https://github.com/swaywm/wlroots 92[wlroots]: https://gitlab.freedesktop.org/wlroots/wlroots
93[swaybg]: https://github.com/swaywm/swaybg/
90[scdoc]: https://git.sr.ht/~sircmpwn/scdoc 94[scdoc]: https://git.sr.ht/~sircmpwn/scdoc