diff --git a/README.md b/README.md index 2fd1791..021e214 100644 --- a/README.md +++ b/README.md @@ -3,26 +3,21 @@ join-dic-hunspell Join dic files to make a dic file for hunspell -USAGE: join_dicts.py [options] ... - - - -DESCRIPTION - +## DESCRIPTION Join dic files and wordlists to make a dic file for hunspell. This can be used -in texstudio and other programs. This repository includes some technical word +in TeXstudio and other programs. This repository includes some technical word lists for testing. Also a generic .aff file to go with the produced .dic file. +## USAGE +``` bash +$ join_dicts.py [options] ... +``` +#### ARGS +``` bash +-d ... # Dictionaries to combine +``` -ARGS: - --d dictionaries to combine - - - -EXAMPLE: python join_dicts.py -d wordlist1.dic wordlist2.dic - - - - +#### EXAMPLE +``` bash +$ python join_dicts.py -d wordlist1.dic wordlist2.dic