changing style of readme, I also recommend add a license (see https://choosealicense.com/)

This commit is contained in:
Rubenmp
2017-08-08 21:55:30 +02:00
parent 8d5243ce3e
commit 3359943436
+13 -18
View File
@@ -3,26 +3,21 @@ join-dic-hunspell
Join dic files to make a dic file for hunspell
USAGE: join_dicts.py [options] <file/directory>...
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] <file/directory>...
```
#### ARGS
``` bash
-d <dictionary1> <dictionary2> ... # 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