summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGard Spreemann <gspreemann@gmail.com>2016-03-29 14:20:14 +0200
committerGard Spreemann <gspreemann@gmail.com>2016-03-29 14:20:14 +0200
commit40c7912ebff309a0db3e7ab6ace7a8c8b290e486 (patch)
tree64933727c8a9e34466dedf174c1101ad15a94ca7
parent239ba67be0b0e0489bac4b75956f017cfca2aef8 (diff)
Minor documentation changes.
-rw-r--r--README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/README.md b/README.md
index 6219368..b2bc29b 100644
--- a/README.md
+++ b/README.md
@@ -54,18 +54,19 @@ Todo/missing
* More flexible plotting.
* Possibly introduce a barcode class that keeps track of its own
maximal scale.
+* HTML documentation from the docstrings.
Use
=====
-I primarily use this scripts to convert to and from DIPHA's file
+I primarily use this module to convert to and from DIPHA's file
formats. The `DiphaRunner` class is available for those who would like
to avoid manually running DIPHA.
I am not aiming for great performance, efficiency or generality with
-these scripts. If you you want either, you are better off writing the
-DIPHA files yourself. The scripts are intended to be easy to use.
+this code. If you you want either, you are better off writing the
+DIPHA files yourself. The modules are intended to be easy to use.
Examples