diff --git a/.krazy b/.krazy index 49b722b7..e87bab40 100644 --- a/.krazy +++ b/.krazy @@ -19,3 +19,4 @@ SKIP Doxyfile.cmake SKIP \.cmake-format\.py #skip the borrowed code in the cmake subdir SKIP /cmake/ECM/|/cmake/KDAB/ +SKIP .markdownlint.json diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 00000000..e2f811ca --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,16 @@ +{ + "default": true, + "MD007": { + "indent": 2, + "start_indented": false + }, + "MD013": { + "line_length": 100, + "tables": false, + "code_blocks": false + }, + "MD029": { + "style": "ordered" + }, + "MD033": false +} diff --git a/.mdlrc b/.mdlrc deleted file mode 100644 index 3acbfeca..00000000 --- a/.mdlrc +++ /dev/null @@ -1 +0,0 @@ -style ".mdlrc.rb" diff --git a/.mdlrc.rb b/.mdlrc.rb deleted file mode 100644 index 3f9b2488..00000000 --- a/.mdlrc.rb +++ /dev/null @@ -1,5 +0,0 @@ -all -rule 'MD013', :line_length => 100, :tables => false -rule 'MD029', :style => :ordered -exclude_rule 'MD033' -exclude_rule 'MD041' diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e6959702..5239a967 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -45,12 +45,10 @@ repos: exclude: (.py.cmake|Doxyfile.cmake) - id: cmake-format exclude: (.py.cmake|Doxyfile.cmake) -- repo: https://github.com/markdownlint/markdownlint +- repo: https://github.com/DavidAnson/markdownlint-cli2 rev: v0.12.0 hooks: - - id: markdownlint - entry: mdl - language: ruby + - id: markdownlint-cli2 files: \.(md|mdown|markdown)$ - repo: https://github.com/fsfe/reuse-tool rev: v4.0.3 diff --git a/.reuse/dep5 b/.reuse/dep5 index bf72c1e4..abce1ae6 100644 --- a/.reuse/dep5 +++ b/.reuse/dep5 @@ -19,7 +19,7 @@ Copyright: Klarälvdalens Datakonsult AB, a KDAB Group company License: MIT #misc config files -Files: .pre-commit-config.yaml .codespellrc .krazy .cmake-format.py .clang-format .clang-tidy .clazy .gitignore .mdlrc .mdlrc.rb .pep8 .pylintrc .editorconfig .shellcheck docs/api/Doxyfile.cmake distro/* +Files: .pre-commit-config.yaml .codespellrc .krazy .cmake-format.py .clang-format .clang-tidy .clazy .gitignore .markdownlint.json .pep8 .pylintrc .editorconfig .shellcheck docs/api/Doxyfile.cmake distro/* Copyright: Klarälvdalens Datakonsult AB, a KDAB Group company License: BSD-3-Clause diff --git a/README-bindings.md b/README-bindings.md index dd27395a..c0a8e791 100644 --- a/README-bindings.md +++ b/README-bindings.md @@ -55,6 +55,7 @@ except installing `shiboken6 pyside6 shiboken6_generator` with pip3. ## Building KDReports Python Bindings Tell CMake to build the bindings by passing the `-DKDReports_PYTHON_BINDINGS=True' option. + Then run `cmake --build` as usual. The bindings will be installed to `CMAKE_INSTALL_PREFIX`, which might require setting diff --git a/README.md b/README.md index 80e1ef7d..6b8d81ac 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ +# Introduction +
- - +<kdreports-trademark> +<kdreports-logo>
-# Introduction - KD Reports is a Qt tool that lets you easily create printable reports by providing all of the necessary features for a variety of applications. Reports can be created programmatically, using an easy to use C++ API, or they @@ -42,7 +42,7 @@ The starting point for using KD Reports is the KDReports::Report class. * See our official home page: * Visit us on GitHub: -* Email info@kdab.com for questions about this product. +* Email for questions about this product. Stay up-to-date with KDAB product announcements: