[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-taler-util] 03/05: restructure README
From: |
gnunet |
Subject: |
[taler-taler-util] 03/05: restructure README |
Date: |
Mon, 16 Dec 2019 13:29:18 +0100 |
This is an automated email from the git hooks/post-receive script.
ng0 pushed a commit to branch master
in repository taler-util.
commit ef60900a244b6c57c2161ba893848589a4f35333
Author: ng0 <address@hidden>
AuthorDate: Mon Dec 16 12:18:47 2019 +0000
restructure README
---
README | 36 ++++++++++++++++++++++++++++--------
1 file 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.
--
To stop receiving notification emails like this one, please contact
address@hidden.
- [taler-taler-util] branch master updated (0ee7b5d -> 81ff4d3), gnunet, 2019/12/16
- [taler-taler-util] 01/05: remove emacs file which is now in build-system repo, gnunet, 2019/12/16
- [taler-taler-util] 02/05: bump submodule to include switch to type, gnunet, 2019/12/16
- [taler-taler-util] 05/05: bump version in preparation for release, add more Makefile rules, fix readme, gnunet, 2019/12/16
- [taler-taler-util] 03/05: restructure README,
gnunet <=
- [taler-taler-util] 04/05: add manifest to exclude and include files in sdist, gnunet, 2019/12/16