summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorng0 <ng0@n0.is>2019-12-16 12:18:47 +0000
committerng0 <ng0@n0.is>2019-12-16 12:18:47 +0000
commitef60900a244b6c57c2161ba893848589a4f35333 (patch)
tree65456b17426966f40aea55538a17e58eb3026919 /README
parent1a2054fa1a7879b5a1c7c0b29c6f17eb82e72ef9 (diff)
downloadtaler-util-ef60900a244b6c57c2161ba893848589a4f35333.tar.gz
taler-util-ef60900a244b6c57c2161ba893848589a4f35333.tar.bz2
taler-util-ef60900a244b6c57c2161ba893848589a4f35333.zip
restructure README
Diffstat (limited to 'README')
-rw-r--r--README36
1 files changed, 28 insertions, 8 deletions
diff --git a/README b/README
index 56cddf4..7f884f0 100644
--- a/README
+++ b/README
@@ -1,21 +1,41 @@
taler-util
==========
-util code for the GNU Taler project.
+taler-util contains util code for the GNU Taler project,
+specifically it contains python code for:
-License
--------
-
-Python modules contained in this package are licensed LGPL 3 (or later).
+- amount representation
+- logging
+- configuration parsing
tests
-----
+
To run the unittests, execute
- python3.7 setup.py test
+ tox
+
+or
+
+ make test
Installation
------------
-You can use standard python tools to handle the setup,
-or use the Makefile and GNU standards wrapper around them.
+The wheel release can be installed as-is from pypi.org
+as it includes only what is necessary.
+
+The source distribution tarball (sdist) includes two
+build-systems:
+
+1. a small GNU guidelines following wrapper around python's pip
+2. python's default build-facility used via setup
+
+License
+-------
+
+Python modules contained in this package are licensed LGPL 3 (or later).
+
+This does not cover code contained in build-system/taler-build-scripts,
+which is included in the source distribution of this software.
+taler-build-scripts is (mostly) 0BSD / public-domain software.