aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-11-28 01:58:37 +0100
committerMattias Andrée <maandree@operamail.com>2015-11-28 01:58:37 +0100
commit7a908b3e0522e6971c9d83adffdea2440b06f97c (patch)
tree01e82ebb69494b5b23cdc7f9d523cadc0fba3066 /README
parentupdate dist (diff)
downloadsolar-python-7a908b3e0522e6971c9d83adffdea2440b06f97c.tar.gz
solar-python-7a908b3e0522e6971c9d83adffdea2440b06f97c.tar.bz2
solar-python-7a908b3e0522e6971c9d83adffdea2440b06f97c.tar.xz
improve readme
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'README')
-rw-r--r--README16
1 files changed, 13 insertions, 3 deletions
diff --git a/README b/README
index cd0bc68..6575691 100644
--- a/README
+++ b/README
@@ -1,4 +1,14 @@
-Python library that can be used to calculate information
-about the Sun's position and related data and predict at
-when time solar events occur.
+NAME
+ solar-python - Solar data calculation and prediction library for Python
+
+DESCRIPTION
+ Python library that can be used to calculate information about the Sun's
+ position and related data and predict at when time solar events occur.
+
+RATIONALE
+ This was needed by blueshift(1) to select appropriate colour temperature.
+ There is no reason not to put it in its own library.
+
+SEE ALSO
+ blueshift(1), redshift(1)