aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMitch Curtis <mitch.curtis@qt.io>2017-01-31 10:52:34 +0100
committerMitch Curtis <mitch.curtis@qt.io>2017-02-01 08:39:22 +0000
commite967e50805e50decd809236da314127cd425ef0b (patch)
treec45fbac799d4cbff3579bcbcf5fd24e71fa319ad
parent40455c50331757aff9a315b0450be00646b5a03e (diff)
Doc: provide an example of how 3rdparty/hunspell should look
It can be difficult to get the directory structure right, so having this example will make it easy for the user to check if they’ve copied in the Hunspell sources correctly. Change-Id: I15dbafff37f44c2ea24d24077d8387898dd49ca3 Reviewed-by: Jarkko Koivikko <jarkko.koivikko@code-q.fi> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
-rw-r--r--src/virtualkeyboard/doc/src/build.qdoc17
1 files changed, 17 insertions, 0 deletions
diff --git a/src/virtualkeyboard/doc/src/build.qdoc b/src/virtualkeyboard/doc/src/build.qdoc
index add2738b..3d9d9eac 100644
--- a/src/virtualkeyboard/doc/src/build.qdoc
+++ b/src/virtualkeyboard/doc/src/build.qdoc
@@ -264,6 +264,23 @@ then the dictionary files must also be copied into the
\e src/virtualkeyboard/3rdparty/hunspell/data directory. Furthermore, if Hunspell
sources are used, \e hunspell.pro will be used for all targets.
+An example of how the directory structure should look after copying in the
+Hunspell sources and dictionary files is listed below:
+
+\badcode
+3rdparty
+└── hunspell
+ ├── data
+ │ ├── en_GB.aff
+ │ └── en_GB.dic
+ ├── hunspell.pro
+ └── src
+ └── hunspell
+ ├── affentry.cxx
+ ├── affentry.hxx
+ (etc.)
+\endcode
+
\section2 Static builds
The virtual keyboard can be built and linked statically against the application.