From 40c7912ebff309a0db3e7ab6ace7a8c8b290e486 Mon Sep 17 00:00:00 2001 From: Gard Spreemann Date: Tue, 29 Mar 2016 14:20:14 +0200 Subject: Minor documentation changes. --- README.md | 7 ++++--- 1 file 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 -- cgit v1.2.3