From: Urban Wallasch Date: Tue, 22 Jun 2021 18:52:59 +0000 (+0200) Subject: * Added note about regular expression search to README. X-Git-Tag: v0.1.0~68 X-Git-Url: https://git.packet-gain.de/?a=commitdiff_plain;h=7edc3a68b41ef9ad844b732579bf1326482fb964;p=jiten-pai.git * Added note about regular expression search to README. --- diff --git a/README.md b/README.md index 95bb4ff..cb0f21a 100644 --- 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: