update README

This commit is contained in:
Pavol Rusnak 2014-08-20 10:46:12 +02:00
parent ba63157a77
commit 5765fccc0d
2 changed files with 26 additions and 24 deletions

24
README
View File

@ -1,24 +0,0 @@
TREZOR firmware
http://bitcointrezor.com/
How to build Trezor firmware?
=============================
1. Install Docker (docker.com)
2. git clone https://github.com/trezor/trezor-mcu.git
3. cd trezor-mcu
4. sudo ./firmware-docker-build.sh (sudo may be needed on some distros because of Docker)
This generates trezor.bin in current directory and prints sha256 fingerprint on last line of build log.
How to get sha256 fingerprint of firmware signed and distributed by SatoshiLabs?
================================================================================
1. Pick proper version of firmware binary listed on https://mytrezor.com/data/firmware/releases.json
2. Download it: wget -O trezor.signed.bin.hex https://mytrezor.com/data/firmware/trezor-1.1.0.bin.hex
3. xxd -r -p trezor.signed.bin.hex trezor.signed.bin
4. ./firmware-fingerprint.sh trezor.signed.bin
Step 4 should produce the same sha256 fingerprint like your local build.
The reasoning behind "firmware-fingerprint.sh" is that signed firmware has special header holding signatures themselves,
which must be removed before calculating fingerprint.

26
README.rst Normal file
View File

@ -0,0 +1,26 @@
TREZOR Firmware
===============
http://bitcointrezor.com/
How to build Trezor firmware?
-----------------------------
1. Install Docker (from docker.com or from your distribution repositories)
2. ``git clone https://github.com/trezor/trezor-mcu.git``
3. ``cd trezor-mcu``
4. ``./firmware-docker-build.sh``
This creates trezor.bin in current directory and prints its fingerprint at the last line of the build log.
How to get fingerprint of firmware signed and distributed by SatoshiLabs?
-------------------------------------------------------------------------
1. Pick version of firmware binary listed on https://mytrezor.com/data/firmware/releases.json
2. Download it: ``wget -O trezor.signed.bin.hex https://mytrezor.com/data/firmware/trezor-1.1.0.bin.hex``
3. ``xxd -r -p trezor.signed.bin.hex trezor.signed.bin``
4. ``./firmware-fingerprint.sh trezor.signed.bin``
Step 4 should produce the same sha256 fingerprint like your local build.
The reasoning for ``firmware-fingerprint.sh`` script is that signed firmware has special header holding signatures themselves, which must be avoided while calculating the fingerprint.