Skip to content

Commit

Permalink
CHANGES, README.md, INSTALL.md - updates for 3.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Allen Winter committed Jul 26, 2024
1 parent c4eec80 commit 716da1b
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 6 deletions.
5 changes: 1 addition & 4 deletions CHANGES
Original file line number Diff line number Diff line change
Expand Up @@ -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)
---------------------------------
Expand Down
15 changes: 13 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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_<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 (<https://github.com/KDAB/KDStateMachineEditor>).
functionality.
When you run cmake it will inform you about these missing dependencies.
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down

0 comments on commit 716da1b

Please sign in to comment.