From ec8c1d5789cea089fcf2a19b05aff45604562ae7 Mon Sep 17 00:00:00 2001 From: Tadej Novak Date: Tue, 27 Aug 2024 21:49:29 +0200 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Bart Louwers --- README.md | 4 ++-- docs/Building.md | 4 ++-- docs/Documentation.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 18e048c..6e830d5 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ MapLibre Native Qt bindings and Qt Location MapLibre Plugin -**Important notice:** Repository and code has been reorganised for Qt 6.5 support. +**Important notice:** the repository and code have been reorganised for Qt 6.5 support. Version 3.0 is a major release that includes a lot of build-related changes and improvements and is not backwards compatible. @@ -24,7 +24,7 @@ cd maplibre-native-qt git submodule update --init --recursive ``` -(On some file systems, the submodule update may yield `Filename too long` error +(On some file systems, the submodule update may yield a `Filename too long` error which can be ignored.) For more details on building the project, see [How to build](docs/Building.md). diff --git a/docs/Building.md b/docs/Building.md index a64f232..c68039c 100644 --- a/docs/Building.md +++ b/docs/Building.md @@ -15,8 +15,8 @@ bindings build in the same step. To speed-up the build, `ninja` and `ccache` are recommended. For Qt 6 using the `qt-cmake` wrapper instead of plain `cmake` makes building non-desktop platforms easier. -@note To make sure correct Qt 6 version is used, use the provided toolchain file -using `-DCMAKE_TOOLCHAIN_FILE="/lib/cmake/Qt6/qt.toolchain.cmake"` +@note To make sure a correct version of Qt 6 is used, use the provided toolchain file +with `-DCMAKE_TOOLCHAIN_FILE="/lib/cmake/Qt6/qt.toolchain.cmake"` A minimal example command is: diff --git a/docs/Documentation.md b/docs/Documentation.md index 8bd6925..e45462a 100644 --- a/docs/Documentation.md +++ b/docs/Documentation.md @@ -13,7 +13,7 @@ cd maplibre-native-qt git submodule update --init --recursive ``` -@note On some file systems, the submodule update may yield `Filename too long` +@note On some file systems, the submodule update may yield a `Filename too long` error. It can be ignored as only some dependencies test data will be missing.