diff --git a/src/getting-started.md b/src/getting-started.md index d1d3611..7157c36 100644 --- a/src/getting-started.md +++ b/src/getting-started.md @@ -3,7 +3,7 @@ Labwc is designed to be easy to get started with. To use the compositor for the first time, there is no need for configuration -files, theme files or even a session file. It should be enough to simply run +files, theme files or even a session file. It should be enough to simply run the labwc binary from a TTY or Wayland/X11 session. If labwc is not packaged by your OS/distribution of choice, it is quite easy @@ -35,21 +35,12 @@ Alt-F3 to launch applications. # Configuration -User config files are located at `${XDG_CONFIG_HOME:-$HOME/.config/labwc/}` -(usually `~/.config/labwc/`) with the following five files being used: +Example config files, which reflect the default configuration of labwc, are located at `/usr/share/doc/labwc/`. You can either modify those or +create your own ones by copying them to `${XDG_CONFIG_HOME:-$HOME/.config/labwc/}` +(usually `~/.config/labwc/`), with the following five files being used: [rc.xml], [menu.xml], [autostart], [environment] and [themerc-override]. -The example [rc.xml] has been kept simple. For all options and default values, -see [rc.xml.all] - -For full details on configuration options, see the man pages: -[labwc(1)], [labwc-config(5)], [labwc-theme(5)], [labwc-actions(5)] and -[labwc-menu(5)]. - -Run `labwc --reconfigure` to reload configuration and theme files. - -Your OS/Distribution of choice may include these example configuration files in -`/usr/share/doc/labwc/` or similar. If not, you could download them with: +Your OS/Distribution of choice may include these example configuration files. If not, you could download them with: ```bash mkdir -p ~/.config/labwc @@ -62,10 +53,19 @@ wget https://raw.githubusercontent.com/labwc/labwc/master/docs/rc.xml -O ~/.conf > **_NOTE:_** Before using these configuration files, please read them through > and modify the content to suit your specific needs. +The example [rc.xml] has been kept simple. For all options and default values, +see [rc.xml.all] + +For full details on configuration options, see the man pages: +[labwc(1)], [labwc-config(5)], [labwc-theme(5)], [labwc-actions(5)] and +[labwc-menu(5)]. + +Run `labwc --reconfigure` to reload configuration and theme files. + For more information about each configuration file and to help create a setup that work for you, please read through the sections below. -If you get stuck, do reach out on the [IRC Channel] or [Github Discussions]. +If you get stuck, do reach out on the [IRC Channel] or [GitHub Discussions]. [rc.xml]: https://github.com/labwc/labwc/blob/master/docs/rc.xml [rc.xml.all]: https://github.com/labwc/labwc/blob/master/docs/rc.xml.all @@ -80,7 +80,7 @@ If you get stuck, do reach out on the [IRC Channel] or [Github Discussions]. [labwc-theme(5)]: https://labwc.github.io/labwc-theme.5.html [labwc-actions(5)]: https://labwc.github.io/labwc-actions.5.html [IRC Channel]: https://web.libera.chat/gamja/?channels=#labwc -[Github Discussions]: https://github.com/labwc/labwc/discussions +[GitHub Discussions]: https://github.com/labwc/labwc/discussions ## Step 1 - Set your keyboard layout diff --git a/src/index.md b/src/index.md index 7faecf0..e1c2c9e 100644 --- a/src/index.md +++ b/src/index.md @@ -13,13 +13,14 @@ be controlled with dbus, sway/i3-IPC or other technology. The reason for this is that we believe that custom IPCs and protocols create a fragmentation that hinders general Wayland adoption. - - + + +The obligatory screenshot. [wayland]: https://wayland.freedesktop.org/ [openbox]: http://openbox.org/ [wlroots]: https://gitlab.freedesktop.org/wlroots/wlroots [sway]: https://github.com/swaywm [wayland-protocols]: https://gitlab.freedesktop.org/wayland/wayland-protocols -[wlr-protocols]: https://gitlab.freedesktop.org/wlroots/wlr-protocols +[wlr-protocols]: https://gitlab.freedesktop.org/wlroots/wlr-protocols \ No newline at end of file