From 83580d6116e92445d382fd87a8db154850ef33df Mon Sep 17 00:00:00 2001 From: redtide Date: Thu, 11 Apr 2024 19:43:27 +0200 Subject: [PATCH] Updated README with the latest changes --- README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 50 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9c07f8e..74ae106 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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].
+`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