Skip to content

Commit

Permalink
Updated README with the latest changes
Browse files Browse the repository at this point in the history
  • Loading branch information
redtide authored and johanmalm committed Apr 15, 2024
1 parent a21cdde commit 83580d6
Showing 1 changed file with 50 additions and 8 deletions.
58 changes: 50 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# labwc-tweaks

[![CI]](https://github.com/labwc/labwc-tweaks/actions/workflows/build.yml)

This is a [WIP] configuration gui app for labwc without any real plan or
Acceptance Criteria. It was merely written to help change themes for the
purposes of testing labwc during development. Don't expect too much :smile:
Expand All @@ -9,23 +11,63 @@ purposes of testing labwc during development. Don't expect too much :smile:
If you install labwc-gtktheme.py and set labwc-theme to GTK it'll
automatically sync with the selected GTK theme.

### dependencies

Runtime:

- Qt6 base
- libxml2
- glib2

Build:

- CMake
- Qt Linguist Tools
- Git (optional, to pull latest VCS checkouts)

### build

```
meson setup build
meson compile -C build
`CMAKE_BUILD_TYPE` is usually set to `Release`, though `None` might be a valid [alternative].<br>
`CMAKE_INSTALL_PREFIX` has to be set to `/usr` on most operating systems.

```bash
cmake -B build -D CMAKE_BUILD_TYPE=Release -D CMAKE_INSTALL_PREFIX=/usr -W no-dev
cmake --build build --verbose
```

### install

```
meson install -C build
```
Using `sudo make install` is discouraged, instead use the system package manager where possible.

This installs the binary to /usr/local/bin and data files to their respective locations.
In this packaging simulation, CMake installs the binary to /usr/bin
and data files to their respective locations in a "package" directory.

```bash
DESTDIR="$(pwd)/package" cmake --install build
```

If you find it a useful tool and want to expand its scope, feel free.

### packages

[![Packaging status](https://repology.org/badge/vertical-allrepos/labwc-tweaks.svg)](https://repology.org/project/labwc-tweaks/versions)
[![Packaging status]](https://repology.org/project/labwc-tweaks/versions)

### translations

For contributing translations the [LXQt Weblate] platform can be used.

[![Translation status]](https://translate.lxqt-project.org/widgets/labwc/)

### licenses

- labwc-tweaks is licensed under the [GPL-2.0-only] license
- LXQt build tools cmake modules are licensed under the [BSD-3-Clause] license.


[alternative]: https://wiki.archlinux.org/title/CMake_package_guidelines#Fixing_the_automatic_optimization_flag_override
[BSD-3-Clause]: BSD-3-Clause
[CI]: https://github.com/labwc/labwc-tweaks/actions/workflows/build.yml/badge.svg
[GPL-2.0-only]: LICENSE
[LXQt Weblate]: https://translate.lxqt-project.org/projects/labwc/labwc-tweaks/
[Packaging status]: https://repology.org/badge/vertical-allrepos/labwc-tweaks.svg
[Translation status]: https://translate.lxqt-project.org/widgets/labwc/-/labwc-tweaks/multi-auto.svg

0 comments on commit 83580d6

Please sign in to comment.