diff options
author | Simon Ser <contact@emersion.fr> | 2020-12-18 11:31:04 +0100 |
---|---|---|
committer | Brian Ashworth <bosrsf04@gmail.com> | 2020-12-18 18:33:04 -0500 |
commit | fce8287a06bdf1f951c9d48fb0b799ed86a0210b (patch) | |
tree | 33ee62129d9fcef7c68ce7380766e745358ede08 /README.md | |
parent | ISSUE_TEMPLATE: the wiki is community maintained (diff) | |
download | sway-fce8287a06bdf1f951c9d48fb0b799ed86a0210b.tar.gz sway-fce8287a06bdf1f951c9d48fb0b799ed86a0210b.tar.zst sway-fce8287a06bdf1f951c9d48fb0b799ed86a0210b.zip |
readme: use references for links
This avoids cluttering the README text with URLs.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 46 |
1 files changed, 35 insertions, 11 deletions
@@ -1,19 +1,16 @@ | |||
1 | # sway | 1 | # sway |
2 | 2 | ||
3 | [**English**](https://github.com/swaywm/sway/blob/master/README.md#sway--) - [日本語](https://github.com/swaywm/sway/blob/master/README.ja.md#sway--) - [Français](https://github.com/swaywm/sway/blob/master/README.fr.md#sway--) - [Українська](https://github.com/swaywm/sway/blob/master/README.uk.md#sway--) - [Español](https://github.com/swaywm/sway/blob/master/README.es.md#sway--) - [Polski](https://github.com/swaywm/sway/blob/master/README.pl.md#sway--) - [中文-简体](https://github.com/swaywm/sway/blob/master/README.zh-CN.md#sway--) - [Deutsch](https://github.com/swaywm/sway/blob/master/README.de.md#sway--) - [Nederlands](https://github.com/swaywm/sway/blob/master/README.nl.md#sway--) - [Русский](https://github.com/swaywm/sway/blob/master/README.ru.md#sway--)- [中文-繁體](https://github.com/swaywm/sway/blob/master/README.zh-TW.md#sway--) - [Português](https://github.com/swaywm/sway/blob/master/README.pt.md#sway--) - [Danish](https://github.com/swaywm/sway/blob/master/README.dk.md#sway--) - [한국어](https://github.com/swaywm/sway/blob/master/README.ko.md#sway--) - [Română](https://github.com/swaywm/sway/blob/master/README.ro.md#sway--) | 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] |
4 | 4 | ||
5 | sway is an [i3](https://i3wm.org/)-compatible [Wayland](http://wayland.freedesktop.org/) compositor. | 5 | sway is an [i3]-compatible [Wayland] compositor. Read the [FAQ]. Join the |
6 | Read the [FAQ](https://github.com/swaywm/sway/wiki). Join the [IRC | 6 | [IRC channel] \(#sway on irc.freenode.net). |
7 | channel](http://webchat.freenode.net/?channels=sway&uio=d4) (#sway on | ||
8 | irc.freenode.net). | ||
9 | 7 | ||
10 | If you'd like to support sway development, please contribute to [SirCmpwn's | 8 | If you'd like to support sway development, please contribute to [SirCmpwn's |
11 | Patreon page](https://patreon.com/sircmpwn). | 9 | Patreon page]. |
12 | 10 | ||
13 | ## Release Signatures | 11 | ## Release Signatures |
14 | 12 | ||
15 | Releases are signed with [E88F5E48](https://keys.openpgp.org/search?q=34FF9526CFEF0E97A340E2E40FDE7BE0E88F5E48) | 13 | Releases are signed with [E88F5E48] and published [on GitHub][GitHub releases]. |
16 | and published [on GitHub](https://github.com/swaywm/sway/releases). | ||
17 | 14 | ||
18 | ## Installation | 15 | ## Installation |
19 | 16 | ||
@@ -27,12 +24,13 @@ channel or shoot an email to sir@cmpwn.com for advice. | |||
27 | 24 | ||
28 | ### Compiling from Source | 25 | ### Compiling from Source |
29 | 26 | ||
30 | Check out [this wiki page](https://github.com/swaywm/sway/wiki/Development-Setup) if you want to build the HEAD of sway and wlroots for testing or development. | 27 | Check out [this wiki page][Development setup] if you want to build the HEAD of |
28 | sway and wlroots for testing or development. | ||
31 | 29 | ||
32 | Install dependencies: | 30 | Install dependencies: |
33 | 31 | ||
34 | * meson \* | 32 | * meson \* |
35 | * [wlroots](https://github.com/swaywm/wlroots) | 33 | * [wlroots] |
36 | * wayland | 34 | * wayland |
37 | * wayland-protocols \* | 35 | * wayland-protocols \* |
38 | * pcre | 36 | * pcre |
@@ -40,7 +38,7 @@ Install dependencies: | |||
40 | * pango | 38 | * pango |
41 | * cairo | 39 | * cairo |
42 | * gdk-pixbuf2 (optional: system tray) | 40 | * gdk-pixbuf2 (optional: system tray) |
43 | * [scdoc](https://git.sr.ht/~sircmpwn/scdoc) (optional: man pages) \* | 41 | * [scdoc] (optional: man pages) \* |
44 | * git (optional: version info) \* | 42 | * git (optional: version info) \* |
45 | 43 | ||
46 | _\*Compile-time dep_ | 44 | _\*Compile-time dep_ |
@@ -68,3 +66,29 @@ Run `man 5 sway` for information on the configuration. | |||
68 | 66 | ||
69 | Run `sway` from a TTY. Some display managers may work but are not supported by | 67 | Run `sway` from a TTY. Some display managers may work but are not supported by |
70 | sway (gdm is known to work fairly well). | 68 | sway (gdm is known to work fairly well). |
69 | |||
70 | [en]: https://github.com/swaywm/sway#readme | ||
71 | [ja]: https://github.com/swaywm/sway/blob/master/README.ja.md | ||
72 | [fr]: https://github.com/swaywm/sway/blob/master/README.fr.md | ||
73 | [uk]: https://github.com/swaywm/sway/blob/master/README.uk.md | ||
74 | [es]: https://github.com/swaywm/sway/blob/master/README.es.md | ||
75 | [pl]: https://github.com/swaywm/sway/blob/master/README.pl.md | ||
76 | [zh-CN]: https://github.com/swaywm/sway/blob/master/README.zh-CN.md | ||
77 | [de]: https://github.com/swaywm/sway/blob/master/README.de.md | ||
78 | [nl]: https://github.com/swaywm/sway/blob/master/README.nl.md | ||
79 | [ru]: https://github.com/swaywm/sway/blob/master/README.ru.md | ||
80 | [zh-TW]: https://github.com/swaywm/sway/blob/master/README.zh-TW.md | ||
81 | [pt]: https://github.com/swaywm/sway/blob/master/README.pt.md | ||
82 | [dk]: https://github.com/swaywm/sway/blob/master/README.dk.md | ||
83 | [ko]: https://github.com/swaywm/sway/blob/master/README.ko.md | ||
84 | [ro]: https://github.com/swaywm/sway/blob/master/README.ro.md | ||
85 | [i3]: https://i3wm.org/ | ||
86 | [Wayland]: http://wayland.freedesktop.org/ | ||
87 | [FAQ]: https://github.com/swaywm/sway/wiki | ||
88 | [IRC channel]: http://webchat.freenode.net/?channels=sway&uio=d4 | ||
89 | [SirCmpwn's Patreon page]: https://patreon.com/sircmpwn | ||
90 | [E88F5E48]: https://keys.openpgp.org/search?q=34FF9526CFEF0E97A340E2E40FDE7BE0E88F5E48 | ||
91 | [GitHub releases]: https://github.com/swaywm/sway/releases | ||
92 | [Development setup]: https://github.com/swaywm/sway/wiki/Development-Setup | ||
93 | [wlroots]: https://github.com/swaywm/wlroots | ||
94 | [scdoc]: https://git.sr.ht/~sircmpwn/scdoc | ||