[geany/geany-plugins] 37b1eb: SpellCheck: Improve custom dictionary configuration documentation

[Enrico Tröger]

Branch:      refs/heads/master
Author:      Enrico Tröger <enrico.troeger at uvena.de>
Committer:   Enrico Tröger <enrico.troeger at uvena.de>
Date:        Thu, 25 Apr 2019 19:25:22 UTC
Commit:      37b1ebf3826b95a19281c9047b0de617a51b10ab
             https://github.com/geany/geany-plugins/commit/37b1ebf3826b95a19281c9047b0de617a51b10ab

Log Message:
-----------
SpellCheck: Improve custom dictionary configuration documentation

As discussed in #1627.


Modified Paths:
--------------
    spellcheck/README

Modified: spellcheck/README
27 lines changed, 24 insertions(+), 3 deletions(-)
===================================================================
@@ -50,17 +50,38 @@ Instructions:
 2. The downloaded archive with extensions like .xpi or .oxt is actually a ZIP
    archive, so extract it as usual (e.g. with 7-Zip or another ZIP
    unpacker). Extract the contents into a folder of your choice,
-   e.g. C:\dictionaries
-3. Then open to the Spell Check plugin preferences dialog in Geany and
+   e.g. `C:\\dictionaries`
+3. If the extracted dictionary files contain hyphens ("-"), replace them
+   with underscores
+4. Then open to the Spell Check plugin preferences dialog in Geany and
    choose the folder you just created. You may need to restart Geany
    and then the installed dictionaries should be available
 
 Note: if you are using Enchant 2.0 or later (the library used by the SpellCheck
 plugin), you need to move the dictionaries into a subfolder called "hunspell"
-in the directory you created above.
+in the directory you created above. The directory to be configured in the
+plugin's configuration dialog still is the directory above that folder.
 To check which Enchant version you are using, check "Help->Debug Messages" in
 Geany and find the appropriate log message telling about the Enchant version.
 
+Example::
+
+    C:\
+    ├── dictionaries
+    │   └── hunspell
+    │       ├── ca_ES.aff
+    │       ├── ca_ES.dic
+    │       ├── cs.dic
+    │       ├── cs.dic
+    │       ├── de_DE_frami.aff
+    │       ├── de_DE_frami.dic
+    │       ├── en_GB.aff
+    │       └── en_GB.dic
+    └── ...
+
+Then in the plugin configuration dialog set the dictionary for
+dictionary files to: `C:\\dictionaries`.
+
 
 Known issues
 ------------



--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).