]> git.mdlowis.com Git - proto/labwc.git/commitdiff
Update README.md
authorJohan Malm <jgm323@gmail.com>
Tue, 1 Sep 2020 18:45:36 +0000 (19:45 +0100)
committerJohan Malm <jgm323@gmail.com>
Tue, 1 Sep 2020 18:45:36 +0000 (19:45 +0100)
README.md

index 6fd8cc3ed425a8ad002f0d09ed00c0e6cf58e0fc..1cd773bd651b95625bef959112fef9763a13a8a0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -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.
 
-![](https://raw.githubusercontent.com/wiki/johanmalm/labwc/images/scrot1.png)
+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)
 
-## Table of Contents
+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)
 
-- [Dependencies](#dependencies)
-- [Roadmap](#roadmap)
-- [Inspiration](#inspiration)
-- [Design](#design)
-- [Configuration](#configuration)
-- [Integration](#integration)
-- [Build](#build)
+## 2. 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).
-