commit 93f8d349ea862040e2dd08b4c3dc9d9f1f69c1b8
parent 0081aa83a5a6beb122ae04ea52428189c68c39fc
Author: amin <dev@aminmesbah.com>
Date: Wed, 11 Jan 2017 11:19:13 +0000
Add readme.
FossilOrigin-Name: f2017f5b9903faca51df9cbb9e009a19adf8ab5658ed1cee9168bceee93780d8
Diffstat:
| A | README.rst | | | 38 | ++++++++++++++++++++++++++++++++++++++ |
1 file changed, 38 insertions(+), 0 deletions(-)
diff --git a/README.rst b/README.rst
@@ -0,0 +1,38 @@
+Elemental Speller
+=================
+
+Spell words with elemental symbols from the periodic table ("He", "Cu", etc).
+
+.. figure:: https://cloud.githubusercontent.com/assets/5744114/21043177/7c3efe8c-bdaa-11e6-9c1a-22db4de6bb2f.png
+ :alt: A list of four words and their elemental spellings
+
+ Some words and their elemental spellings
+
+
+Usage
+-----
+
+.. code-block::
+
+ usage: spellement.py [-h] [-b BATCH_FILE] [-c] [--debug] [--list-elements]
+ [-o OUTPUT_FILE] [-s] [-t] [-v] [-V]
+ [words [words ...]]
+
+ Spell words with elemental symbols from the periodic table.
+
+ positional arguments:
+ words word(s) for which to find elemental spellings
+
+ optional arguments:
+ -h, --help show this help message and exit
+ -b BATCH_FILE, --batch-file BATCH_FILE
+ text file containing one word per line
+ -c, --clobber overwrite output file if it exists
+ --debug print debug log
+ --list-elements print list of elemental symbols and exit
+ -o OUTPUT_FILE, --output_file OUTPUT_FILE
+ path of output json file
+ -s, --sort sort words by length
+ -t, --tuples display spellings as tuples
+ -v, --verbose print a detailed log
+ -V, --version print version info and exit
