* Added note about regular expression search to README.
authorUrban Wallasch <urban.wallasch@freenet.de>
Tue, 22 Jun 2021 18:52:59 +0000 (20:52 +0200)
committerUrban Wallasch <urban.wallasch@freenet.de>
Tue, 22 Jun 2021 19:11:40 +0000 (21:11 +0200)
README.md

index 95bb4ff3ab9a197c0a71448f7f9d60d39910cf47..cb0f21abd8a3b0f8261d0c681a2f19ceca9f8c57 100644 (file)
--- a/README.md
+++ b/README.md
@@ -63,6 +63,14 @@ dictionary copyright information and licensing terms.
 * If the search term contains any Katakana or Hiragana, Jiten-pai will
   always report matches for both syllabaries. This is intentional.
 
+* The word search supports Python regular expression syntax to allow for
+  less strict queries. Consequently, backslash-escaping is required when,
+  for whatever reason, searching verbatim for regex special characters
+  like '.', '(', ')', etc.  Using the '^' and '$' regex anchors is
+  strongly discouraged. Equivalent functionality is already provided by
+  the various search options. (If this paragraph is all Greek to you,
+  chances are you can safely ignore it.)
+
 * During startup Jiten-pai will look for the `vconj.utf8` verb conjugation
   file as well as the `kradfile.utf8` and `radkfile.utf8` Kanji radical
   cross-reference files in the following directories, in the given order: