Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: implement labwc #865 and #1363 #42

Closed
wants to merge 7 commits into from
Closed

feat: implement labwc #865 and #1363 #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f59fd12
feat: implement labwc #865 and #1363
ludg1e Jan 17, 2024
5565f6a
fix: dupe
ludg1e Jan 17, 2024
683ae35
fix: change wording according to #43
ludg1e Feb 19, 2024
37ca014
fix: move to html
ludg1e Feb 19, 2024
67b9c8d
Merge branch 'labwc:main' into labwc-865-1363
ludg1e Feb 19, 2024
63ea014
fix: wording of getting-started.md
ludg1e Feb 19, 2024
9e87fc6
fix: note position
ludg1e Feb 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions src/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand 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

Expand Down
7 changes: 4 additions & 3 deletions src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<a href="img/scrot1.png">
<img src="img/scrot1-small.png">
<a href="img/scrot2.png">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't want to change the default screenshot without some dialogue first.

Also, I thing a "figure caption" looks like a report or something. That's why I added a link in template_pre.md instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There hasn't been added a "figure caption" at any moment

If you refer to this text at top message of the thread, it was just a comment of something I tried and never added (thus why the italic), maybe it was misunderstood
image

Edit: removed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest removing the caption and when clicking the img (scrot) it redirects you to the obligatory-screenshot page

<img src="img/scrot2-small.png">
</a>
<small><a href="https://labwc.github.io/obligatory-screenshot.html">The obligatory screenshot.</a></small>

[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