mirrors/labwc
1
0
Fork 0
mirror of https://github.com/labwc/labwc.git synced 2025-10-29 05:40:24 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Johan Malm 2020-09-01 19:45:36 +01:00
parent d9b1d24919
commit 8fb56a94ba
1 changed files with 37 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

81
README.md
View file

@ -1,27 +1,32 @@
# labwc
- [1. What is this?](#1-what-is-this)
- [2. Build](#2-build)
- [3. Configure](#3-configure)
- [4. Run](#4-run)
- [5. Integrate](#5-integrate)
- [6. Roadmap](#6-roadmap)
## 1. What is this?
Labwc is a [WIP] free, stacking compositor for Wayland and has the following aims:
- Be light-weight, small and fast
- Have the look and feel of Openbox
- Have the look and feel of [openbox](https://github.com/danakj/openbox)
- Where practicable, use other software to show wall-paper, take screenshots,
and so on
It is in early development, so expect bugs and missing features.
Labwc has been inspired and influenced by [openbox](https://github.com/danakj/openbox), [sway](https://github.com/swaywm/sway), [cage](https://www.hjdskes.nl/blog/cage-01/), [wio](https://wio-project.org/) and [rootston](https://github.com/swaywm/rootston)
Labwc is based on the wlroots library. The following were considered before choosing wlroots: [qtwayland](https://github.com/qt/qtwayland), [grefsen](https://github.com/ec1oud/grefsen), [mir](https://mir-server.io) and [egmde](https://github.com/AlanGriffiths/egmde).
![](https://raw.githubusercontent.com/wiki/johanmalm/labwc/images/scrot1.png)
## Table of Contents
## 2. Build
- [Dependencies](#dependencies)
- [Roadmap](#roadmap)
- [Inspiration](#inspiration)
- [Design](#design)
- [Configuration](#configuration)
- [Integration](#integration)
- [Build](#build)
## Dependencies
meson build && ninja -C build
Runtime dependencies include:
@ -31,7 +36,27 @@ Runtime dependencies include:
- cairo
- pango
## Roadmap
For further details see [tools/build](tools/build) and [wiki/Build](https://github.com/johanmalm/labwc/wiki/Build).
## 3. Configure
See [rc.xml](data/rc.xml) and [themerc](data/themes/labwc-default/openbox-3/themerc) comments for details including keybinds.
If you want to override the defaults, copy data/rc.xml to ~/.config/labwc/ and tweak to suit.
Full details in [labwc(1)](docs/labwc.1.md) and [labwc(5)](docs/labwc.5.md)
## 4. Run
./build/labwc -s <some-application>
## 5. Integrate
Suggested apps to use with labwc:
- [grim](https://github.com/emersion/grim) - Take screenshot
## 6. Roadmap
- [x] Support xwayland
- [x] Parse [rc.xml](data/rc.xml)
@ -48,35 +73,3 @@ Runtime dependencies include:
For further details see [wiki/Roadmap](https://github.com/johanmalm/labwc/wiki/Roadmap).
## Inspiration
Labwc has been inspired and inflenced by [openbox](https://github.com/danakj/openbox), [sway](https://github.com/swaywm/sway), [cage](https://www.hjdskes.nl/blog/cage-01/), [wio](https://wio-project.org/) and [rootston](https://github.com/swaywm/rootston)
## Design
Labwc is based on the wlroots library.
The following were considered before choosing wlroots: [qtwayland](https://github.com/qt/qtwayland), [grefsen](https://github.com/ec1oud/grefsen), [mir](https://mir-server.io) and [egmde](https://github.com/AlanGriffiths/egmde).
## Configuration
See [rc.xml](data/rc.xml) and [themerc](data/themes/labwc-default/openbox-3/themerc) comments for details including keybinds.
Full details in [labwc(1)](docs/labwc.1.md) and [labwc(5)](docs/labwc.5.md)
Suggest either copying data/rc.xml to ~/.config/labwc/running, or running with:
./build/labwc -c data/rc.xml
## Integration
Suggested apps:
- [grim](https://github.com/emersion/grim) - screenshots
## Build
meson build && ninja -C build
For further details see [tools/build](tools/build) and [wiki/Build](https://github.com/johanmalm/labwc/wiki/Build).