From 716da1b13f5e2f0ba5cfb5887dbfc4b5e70689a4 Mon Sep 17 00:00:00 2001 From: Allen Winter Date: Fri, 26 Jul 2024 12:13:35 -0400 Subject: [PATCH] CHANGES, README.md, INSTALL.md - updates for 3.1.0 --- CHANGES | 5 +---- INSTALL.md | 15 +++++++++++++-- README.md | 4 ++++ 3 files changed, 18 insertions(+), 6 deletions(-) diff --git a/CHANGES b/CHANGES index fddc60497a..8761a3f019 100644 --- a/CHANGES +++ b/CHANGES @@ -8,10 +8,7 @@ Version 3.1.0 (unreleased) * Qt IVI is no longer supported * Fix inspection of graphics scenes with nested items * Support introspection of PySide apps - -Version 3.0.1 (unreleased) --------------------------- - * + * Support 3rdparty submodules for KDStateMachineEditor (with graphviz) Version 3.0.0 (04 September 2023) --------------------------------- diff --git a/INSTALL.md b/INSTALL.md index 95c8df9978..31123c5851 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -114,7 +114,7 @@ or ... to remove all forwards -### Additional notes +### Debug builds To build a debug version pass `-DCMAKE_BUILD_TYPE=Debug` to cmake. @@ -144,10 +144,21 @@ You can make probe only builds that way: You can still use any cmake flags you want like `CMAKE_DISABLE_FIND_PACKAGE_` etc. +## Building with KDStateMachineEditor + +The KDAB library KDStateMachineEditor is required when building the +State Machine Viewer plugin (-DGAMMARAY_WITH_KDSME=True). + +The code for this library (and its dependencies, most notably graphviz) +is provided with the source bundle in the 3rdparty folder; alternatively, +developers can git clone the associated submodule into 3rdparty. + +Note that additional tools (like Python) may be required to build graphviz. + ## Optional Dependencies GammaRay relies on optional (FOSS) dependencies to help provide some of its -functionality, most prominently KDSME (). +functionality. When you run cmake it will inform you about these missing dependencies. diff --git a/README.md b/README.md index 4a29064581..81f1538726 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,10 @@ Note that this software relies on 3rd party MIT-licensed projects and various other freely distributable files some of which are unused only for testing and not part of the application itself. +For convenience, GammaRay source bundles (.tar.gz or .zip files) contain code for +the [graphviz library](https://gitlab.com/graphviz/graphviz) which is licensed +according to the [Eclipse Public License v1.0](https://www.eclipse.org/legal/epl/epl-v10.html). + ## About KDAB GammaRay is supported and maintained by Klarälvdalens Datakonsult AB (KDAB).