From 33599434369587bff459a4894732d06d9630ac67 Mon Sep 17 00:00:00 2001 From: Rubenmp Date: Tue, 8 Aug 2017 21:55:30 +0200 Subject: [PATCH] changing style of readme, I also recommend add a license (see https://choosealicense.com/) --- README.md | 31 +++++++++++++------------------ 1 file changed, 13 insertions(+), 18 deletions(-) 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