[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-wallet-core] branch master updated: update README
From: |
gnunet |
Subject: |
[taler-wallet-core] branch master updated: update README |
Date: |
Mon, 16 Nov 2020 16:51:21 +0100 |
This is an automated email from the git hooks/post-receive script.
dold pushed a commit to branch master
in repository wallet-core.
The following commit(s) were added to refs/heads/master by this push:
new db904be6 update README
db904be6 is described below
commit db904be62abe41ac96a8ad6b37c631256949835e
Author: Florian Dold <florian@dold.me>
AuthorDate: Mon Nov 16 16:51:09 2020 +0100
update README
---
README | 48 ++++++++++++++++++++++++++++--------------------
1 file changed, 28 insertions(+), 20 deletions(-)
diff --git a/README b/README
index da04f7b3..7af17121 100644
--- a/README
+++ b/README
@@ -1,45 +1,52 @@
-GNU Taler Wallet
-================
+# GNU Taler Wallet
This repository contains the implementation of a wallet for GNU Taler written
in TypeScript.
-Dependencies
-============
+## Dependencies
In order to build the GNU Taler wallet, make sure that you have Node.JS and
pnpm installed.
-Installation
-============
+## Installation
-The CLI version of the wallet supports the normal GNU installation process:
+The CLI version of the wallet supports the normal GNU installation process.
- ./bootstrap && ./configure [ --prefix=$PREFIX ] && make install
+```shell
+./configure [ --prefix=$PREFIX ] && make install
+```
-
-Building the WebExtension
-=========================
+### Building the WebExtension
The WebExtension can be built via the 'webextension' make target:
- ./bootstrap && ./configure && make webextension
+```shell
+./configure && make webextension
+```
This will create the zip file with the WebExtension in the location
- packages/taler-wallet-webextension/taler-wallet-$VERSION.zip
+```
+packages/taler-wallet-webextension/taler-wallet-$VERSION.zip
+```
+
+### Compiling from Git
+If you are compiling the code from git, you have to run `./bootstrap` before
+running `./configure`.
-Integration Tests
-=================
+
+# Integration Tests
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:
- cd packages/taler-integrationtests/
- ./testrunner '*'
+```shell
+cd packages/taler-integrationtests/
+./testrunner '*'
+```
The test runner accepts a bash glob pattern as parameter. Individual tests can
be run by specifying their name.
@@ -47,6 +54,7 @@ be run by specifying their name.
To check coverage, use nyc from the root of the repository and make sure that
the taler-wallet-cli
from the source tree is executed, and not the globally installed one:
- PATH="$PWD/packages/taler-wallet-cli/bin:$PATH" \
- nyc ./packages/taler-integrationtests/testrunner '*'
-
+```
+PATH="$PWD/packages/taler-wallet-cli/bin:$PATH" \
+ nyc ./packages/taler-integrationtests/testrunner '*'
+```
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [taler-wallet-core] branch master updated: update README,
gnunet <=