more standardized binaries, better README

This commit is contained in:
Florian Dold 2019-08-19 13:29:59 +02:00
parent da6b6e1049
commit 54fec75279
No known key found for this signature in database
GPG Key ID: D2E4F00F29D02A4B
3 changed files with 41 additions and 24 deletions

60
README
View File

@ -1,34 +1,46 @@
GNU Taler Wallet
================
Cross-browser GNU Taler wallet written for the WebExtensions API.
This package implements a wallet for GNU Taler 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
============
Dependencies are managed as NPM dependencies. For performance reasons,
we use `yarn' as a replacement for `npm' in the build system.
For cryptographic operations, the wallet uses an emscripten-compiled
library. The binary files for this library are in `./emscripten'.
The instructions for building this binary from scrach can be found
in the libtaler-emscripten repository:
https://git.taler.net/libtalerutil-emscripten.git/
Building from source (Web Extension)
======================================
Run `./configure && make' to create an archive
containing the extension in ./build/taler-wallet-$VERSION.zip
Building from source (Node.JS)
======================================
Run `./configure && make tsc' to build the wallet. The command line
interface for the wallet is available in `./bin/taler-wallet-cli'.
Installation
============
Run `./configure && make' to create an archive
containing the extension in ./build/taler-wallet-$VERSION.zip
To install the package permanently on your system, run:
Dependencies
============
$ npm install -g --prefix $PREFIX .
See thirdparty/README for a list of dependencies that are checked into this
repository as a git subtree.
This project also has the following third-party runtime dependencies, which
are checked in compiled or minified form:
- React (Facebook Inc., BSD License)
Emscripten compiled dependencies:
* libgnunetutil
* libgnunetjson
* libgcrypt
* libunistring
Documentation
=============
See the documentation at http://doc.taler.net/dev-wallet-wx.html
The binaries will be installed to `$PREFIX/bin'.

2
bin/taler-wallet-cli Executable file
View File

@ -0,0 +1,2 @@
#!/usr/bin/env node
require('../dist/node/headless/taler-wallet-cli.js')

View File

@ -12,6 +12,9 @@
"bin": {
"taler-wallet-cli": "./bin/taler-wallet-cli"
},
"scripts": {
"build": "make tsc"
},
"devDependencies": {
"@types/moment": "^2.13.0",
"@types/react": "^16.4.0",