From 2a4d2944aa4cd3045ae0b9c1569395c484eb4d05 Mon Sep 17 00:00:00 2001 From: Florian Dold Date: Mon, 10 Aug 2020 17:02:08 +0530 Subject: readme --- README | 50 ++++++++++++++------------------------------------ 1 file changed, 14 insertions(+), 36 deletions(-) diff --git a/README b/README index c3e511ccc..93eaf4ed3 100644 --- a/README +++ b/README @@ -1,49 +1,27 @@ GNU Taler Wallet ================ -This package implements a wallet for GNU Taler in TypeScript. +This repository contains the implementation of a wallet for GNU Taler written +in TypeScript. -It can be run on different platforms: -1. As a cross-browser extension, written for the WebExtension API -2. As a Node.js package - -Dependencies +Installation ============ -Dependencies are managed as NPM dependencies. For performance reasons, -we use `yarn' as a replacement for `npm' in the build system. - - -pre-configure step -================== - -When building from source, run - -`./bootstrap` - +The CLI version of the wallet supports the normal GNU installation process: -Building from source (Web Extension) -====================================== + ./bootstrap && ./configure [ --prefix=$PREFIX ] && make install -Run `./configure --prefix=$PREFIX && make webex-stable' -to create an archive containing the extension -in ./build/taler-wallet-$VERSION.zip +Integration Tests +================= -Building from source (Node.JS) -====================================== - -Run `./configure --prefix=$PREFIX && make' to build the wallet. -The command line interface for the wallet is available -in `./bin/taler-wallet-cli'. - - -Installation -============ - -To install the package permanently on your system, run: +This repository comes with integration tests for GNU Taler. To run them, +install the wallet first. Then use the test runner from the +taler-integrationtests package: -`$ npm install -g --prefix $PREFIX .`` + cd packages/taler-integrationtests/ + ./testrunner '*' -The binaries will be installed to `$PREFIX/bin`. +The test runner accepts a bash glob pattern as parameter. Individual tests can +be run by specifying their name. -- cgit v1.2.3