burrow/README.md

31 lines
1.0 KiB
Markdown
Raw Permalink Normal View History

2020-09-01 13:13:05 +00:00
# Rudefox Burrow
2020-09-01 12:18:32 +00:00
2020-09-02 21:58:01 +00:00
*Offline Bitcoin Seed Generation and Wallet Tool*
2020-09-01 12:18:32 +00:00
2020-09-06 10:18:45 +00:00
Use Burrow on an air-gapped, single-board computer, like a Raspberry Pi, to generate new seed words, derive addresses and extended public keys from existing seed words or sign PSBT transactions offline. Check out the self-audited seed generation feature: [ShowMyWork](https://rudefox.io/blog/2020-07-16-show-my-work.html).
2020-09-01 12:18:32 +00:00
2020-09-06 10:18:45 +00:00
[Rudefox Burrow](https://rudefox.io/burrow/) is released under the [MIT License](LICENSE.md) by B.J. Dweck
2020-09-01 13:13:05 +00:00
2020-09-06 10:18:45 +00:00
## Getting Started
2020-09-01 13:13:05 +00:00
2020-09-06 10:18:45 +00:00
If you simply want to dive in and try your hand at generating a self-audited seed, see the [Burrow Quick Start](https://www.rudefox.io/burrow/quick-start.html) guide.
2020-09-01 13:13:05 +00:00
2020-09-06 10:18:45 +00:00
## Build
2020-09-01 12:18:32 +00:00
2020-09-06 10:18:45 +00:00
### Linux
2020-09-01 12:18:32 +00:00
2020-09-06 10:18:45 +00:00
* Install the Java 8 SDK (Java 8+ is not already installed)
2020-09-01 12:18:32 +00:00
```bash
2020-09-06 10:18:45 +00:00
sudo apt-get install -y openjdk-8-jdk-headless
2020-09-01 12:18:32 +00:00
```
2020-09-02 21:58:01 +00:00
* Clone the repository and build
2020-09-01 12:18:32 +00:00
```bash
2020-09-02 22:58:38 +00:00
git clone https://git.rudefox.io/rudefox/burrow.git
cd burrow
./gradlew build distTar
2020-09-01 12:18:32 +00:00
```
2020-09-06 10:18:45 +00:00
* Find the distribution `.tar` file in `build/distributions/`