Browse Source

Added MIT license

master 0.0.5
B.J. Dweck 1 year ago
parent
commit
baa2387f71
2 changed files with 30 additions and 43 deletions
  1. +21
    -0
      LICENSE.md
  2. +9
    -43
      README.md

+ 21
- 0
LICENSE.md View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2020 B.J. Dweck
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

+ 9
- 43
README.md View File

@ -2,40 +2,22 @@
*Offline Bitcoin Seed Generation and Wallet Tool*
Use [Rudefox](https://rudefox.io/) 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.
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).
## Unique Feature: ShowMyWork
[Rudefox Burrow](https://rudefox.io/burrow/) is released under the [MIT License](LICENSE.md) by B.J. Dweck
[**Rudefox ShowMyWork**](https://rudefox.io/blog/2020-07-16-show-my-work.html) is a feature of Burrow that enables non-technical end-users to audit the seed generation process in order to verify that the generated seed is derived directly from [8-sided dice](https://www.amazon.com/dp/B07XPMV4DQ/) rolls and a set of lookup-tables. Read more [here](https://rudefox.io/blog/2020-07-16-show-my-work.html).
## Getting Started
```bash
[email protected]:~$ burrow mnemonic -i8 --bits 128
Input 11 x 8-sided dice rolls [1-8]: 12345678123
| 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 1 | 2 | 3 |
|000 001 010 01 | 1 100 101 110 1 | 11 000 001 010|
| 1. ahead | 2. slight | 3. scout |
Input 11 x 8-sided dice rolls [1-8]: 12345678123
| 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 1 | 2 | 3 |
|000 001 010 01 | 1 100 101 110 1 | 11 000 001 010|
| 4. ahead | 5. slight | 6. scout |
...
ahead slight scout ahead slight scout ahead slight scout ahead slight scan
```
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.
## Build Instructions
## Build
#### Linux
### Linux
* Install dependencies: Java 8
* Install the Java 8 SDK (Java 8+ is not already installed)
```bash
apt install openjdk-8-jdk
sudo apt-get install -y openjdk-8-jdk-headless
```
* Clone the repository and build
@ -46,20 +28,4 @@ cd burrow
./gradlew build distTar
```
* Find the distribution `.tar` file in `build/distributions/`
## Quick Raspbery Pi Install
* Download the latest [burrow-pi-img](https://git.rudefox.io/rudefox/burrow-pi-img/) image [here](https://repo.rudefox.io/service/rest/v1/search/assets/download?sort=version&group=io.rudefox&name=burrow-pi-img&maven.extension=zip)
* Unzip the image file
* Flash it onto an SD Card
* [Linux](https://www.raspberrypi.org/documentation/installation/installing-images/linux.md)
* [Mac OS](https://www.raspberrypi.org/documentation/installation/installing-images/mac.md)
* [Windows](https://www.raspberrypi.org/documentation/installation/installing-images/windows.md)
* [Chrome OS](https://www.raspberrypi.org/documentation/installation/installing-images/chromeos.md)
* Insert the SD card into the Rasberry Pi and power it up
* **IMPORTANT**: Wait for the device to boot and then wait for it to automatically reboot **TWICE** (once to expand the filesystem and again to activate the read-only filesystem)
* Find the distribution `.tar` file in `build/distributions/`

Loading…
Cancel
Save