From 3a11005d72fd20ed7e5aae94d9a278f63ef9c0b6 Mon Sep 17 00:00:00 2001 From: Johan Malm Date: Sat, 6 Mar 2021 11:45:45 +0000 Subject: [PATCH] Add NEWS.md and update README.md --- NEWS.md | 34 ++++++++++++++++++++++++++++++++++ README.md | 17 ++++++++--------- 2 files changed, 42 insertions(+), 9 deletions(-) create mode 100644 NEWS.md diff --git a/NEWS.md b/NEWS.md new file mode 100644 index 00000000..bd7a398e --- /dev/null +++ b/NEWS.md @@ -0,0 +1,34 @@ +# v0.1.0 2020-03-05 + +Compile with wlroots 0.12.0 and wayland-server >=1.16 + +This first release supports the following: +- xdg-shell +- optionally xwayland-shell +- xbm buttons for maximize, iconify and close +- layer-shell protocol (partial) +- damage tracking to reduce CPU usage +- very basic root-menu implementation +- config and theme re-load on SIGHUP +- openbox style autostart and environment files +- 3 configuration options (openbox compatible) + - `` + - `` + - `` +- 9 themes options (openbox compatible) + - `window.active.title.bg.color` + - `window.active.handle.bg.color` + - `window.inactive.title.bg.color` + - `window.active.button.unpressed.image.color` + - `window.inactive.button.unpressed.image.color` + - `menu.items.bg.color` + - `menu.items.text.color` + - `menu.items.active.bg.color` + - `menu.items.active.text.color` +- 5 actions (openbox compatible) + - `` + - `` + - `` + - `` + - `` + diff --git a/README.md b/README.md index 1234dffc..0bedfca2 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ ## 1. What is this? -Labwc is a [WIP] free, wlroots-based stacking compositor for Wayland. +Labwc is a wlroots-based stacking compositor for Wayland. It has the following aims: @@ -20,8 +20,6 @@ It has the following aims: - Where practicable, use clients to show wall-paper, take screenshots, and so on - Stay in keeping with wlroots and sway in terms of approach and coding style -It is in early development, so expect bugs and missing features. - [Video (3:42) showing features](https://youtu.be/rE1bQjSVJzg) ![](https://raw.githubusercontent.com/wiki/johanmalm/labwc/images/scrot2.png) @@ -30,7 +28,8 @@ It is in early development, so expect bugs and missing features. ## 2. Build - meson build && ninja -C build + meson build/ + ninja -C build/ Dependencies include: @@ -58,14 +57,14 @@ If you want to override the defaults, create the following files: See full details in the following: -- [labwc(1)](docs/labwc.1.md) -- [labwc-config(5)](docs/labwc-config.5.md) -- [labwc-theme(5)](docs/labwc-theme.5.md) -- [labwc-actions(5)](docs/labwc-actions.5.md) +- [labwc(1)](docs/labwc.1.scd) +- [labwc-config(5)](docs/labwc-config.5.scd) +- [labwc-theme(5)](docs/labwc-theme.5.scd) +- [labwc-actions(5)](docs/labwc-actions.5.scd) ## 4. Run - ./build/labwc [-s ] + ./build/labwc [-s ] Click on the background to launch a menu. -- 2.52.0