update readme for initial release

This commit is contained in:
Craig Raw 2020-08-29 17:56:09 +02:00
parent 7e225e794f
commit af36d7b5a5
2 changed files with 38 additions and 8 deletions

View file

@ -1,11 +1,41 @@
# Sparrow
Bitcoin Wallet & Transaction Editor
# Sparrow Bitcoin Wallet
To clone this project, use `git clone --recursive git@github.com:craigraw/sparrow.git`
Sparrow is a modern desktop Bitcoin wallet application supporting most hardware wallets and built on common standards such as PSBT, with an emphasis on transparency and usability.
## Various ways to hex dump a file without spaces:
`xxd -p file | tr -d '\n'`
More information (and release binaries) can be found at https://sparrowwallet.com. Release binaries are also available directly from [Github](https://github.com/sparrowwallet/sparrow/releases).
`hexdump -ve '1/1 "%.2x"'`
![Sparrow Wallet](https://sparrowwallet.com/assets/images/control-your-sends.png)
`od -t x1 -An file | tr -d '\n '`
## Building
To clone this project, use `git clone --recursive git@github.com:sparrowwallet/sparrow.git`
In order to build, Sparrow requires Java 14 to be installed. The release packages can be built using
`./gradlew jpackage`
## Running
If you prefer to run Sparrow directly from source, it can be launched with
`./gradlew run`
Java 14 must be installed.
## Configuration
Sparrow stores it's configuration, log file and wallets in a location appropriate to the operating system:
Platform | Location
-------- | --------
OSX | ~/.sparrow
Linux | ~/.sparrow
Windows | %APPDATA%/Sparrow
## Reporting Issues
Please use the Issues tab above to report an issue. If possible, look in the sparrow.log file in the configuration directory for information helpful in debugging.
## License
Sparrow is licensed under the Apache 2 software licence.

2
drongo

@ -1 +1 @@
Subproject commit bd964e9bd2dca849f0f444d5a40ca65a5eb20fa8
Subproject commit 4ec07e2a91c70a56b419f02e7f75d5a8282b15f3