Usage examples in README

[alexandermorgan]

Can we have some examples of how to use this package in the README? It's really not obvious so even a couple of simple examples would go a long way. Other than pip install dict-fr-au-dela there are no direct uses of the package in the README.

[HubTou]

Hello,

First of all, thank you for reaching out to me.

This package produces only data files in /usr/local/share/dict:
data/dict-fr-AU-DELA
data/dict-fr-AU-DELA-common-compound_words.ascii
data/dict-fr-AU-DELA-common-compound_words.combined
data/dict-fr-AU-DELA-common-compound_words.unicode
data/dict-fr-AU-DELA-common-words.ascii
data/dict-fr-AU-DELA-common-words.combined
data/dict-fr-AU-DELA-common-words.unicode
data/dict-fr-AU-DELA-License
data/dict-fr-AU-DELA-proper_nouns.ascii
data/dict-fr-AU-DELA-proper_nouns.combined
data/dict-fr-AU-DELA-proper_nouns.unicode
data/dict-fr-AU-DELA.ascii
data/dict-fr-AU-DELA.combined
data/dict-fr-AU-DELA.unicode

You have a description of their structure in the file FORMAT.fr.md (in French only).

And (though it's not that obvious), 2 programs that are using it referenced in the See also section:

• Anagram
• Conjuguer

For example, in that last program, check the load_all_verbs_from_dictionary() function in the main.py source file.

This peculiar program is a bit complicated but is a good example of what to do with an inflected dictionary.
Usually you load the dictionary that interest you in memory and start processing it in the way you want.

Alternately, if you use a Unix-like operating system, you can process these files using system tools such as grep just like you would with traditional system dictionaries.

Does that help you? I can try to answer more specific questions or guide you in what you are trying to achieve if you tell me more about it.

I'll update my manual in a few days.

Best regards,