1
0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-12-17 20:08:12 +00:00
trezor-firmware/README.md

104 lines
1.9 KiB
Markdown
Raw Normal View History

2017-03-20 14:49:11 +00:00
# TREZOR Core
2016-10-05 17:45:09 +00:00
![TREZOR Core](docs/trezor_core.png)
2016-02-01 10:52:57 +00:00
2017-08-07 15:48:21 +00:00
[![Build Status](https://travis-ci.org/trezor/trezor-core.svg?branch=master)](https://travis-ci.org/trezor/trezor-core)
[![Gitter](https://badges.gitter.im/trezor/community.svg)](https://gitter.im/trezor/community)
2016-10-03 14:32:58 +00:00
2017-03-20 14:49:11 +00:00
This is the core of the upcoming TREZOR v2.
2016-10-07 12:41:21 +00:00
2017-03-20 14:49:11 +00:00
## Documentation
2016-10-10 10:32:38 +00:00
2016-02-01 16:25:52 +00:00
* [Documentation](docs/)
2016-04-30 22:30:16 +00:00
2017-03-20 14:49:11 +00:00
## Build instructions for emulator
2016-04-30 22:30:16 +00:00
2017-06-06 14:55:12 +00:00
Run the following to checkout the project:
```sh
git clone --recursive https://github.com/trezor/trezor-core.git
cd trezor-core
```
2017-03-20 14:49:11 +00:00
### Linux
2016-04-30 22:30:16 +00:00
2017-03-20 14:49:11 +00:00
#### Debian/Ubuntu
2016-06-03 14:16:07 +00:00
2017-03-20 14:49:11 +00:00
```sh
sudo -H pip install pyblake2
2017-09-05 20:52:07 +00:00
sudo dpkg --add-architecture i386
sudo apt-get update
2017-08-07 15:48:21 +00:00
sudo apt-get install scons libsdl2-dev:i386 libsdl2-image-dev:i386 gcc-multilib
2017-09-05 20:52:07 +00:00
2016-04-30 22:30:16 +00:00
make build_unix
```
2017-03-20 14:49:11 +00:00
#### Fedora
2016-06-03 14:16:07 +00:00
2017-03-20 14:49:11 +00:00
```sh
sudo pip install pyblake2
2017-09-05 20:52:07 +00:00
2017-08-07 15:48:21 +00:00
sudo yum install scons SDL2-devel.i686 SDL2_image-devel.i686
2017-09-05 20:52:07 +00:00
2016-06-03 14:16:07 +00:00
make build_unix
```
2017-03-20 14:49:11 +00:00
#### openSUSE
2016-06-03 14:16:07 +00:00
2017-03-20 14:49:11 +00:00
```sh
sudo pip install pyblake2
2017-09-05 20:52:07 +00:00
2017-08-07 15:48:21 +00:00
sudo zypper install scons libSDL2-devel-32bit libSDL2_image-devel-32bit
2017-09-05 20:52:07 +00:00
2016-06-03 14:16:07 +00:00
make build_unix
```
2017-10-02 14:57:58 +00:00
#### Arch
```sh
sudo pip install pyblake2
sudo pacman -S gcc-multilib scons lib32-sdl2 lib32-sdl2_image
make build_unix
```
2017-03-20 14:49:11 +00:00
### OS X
2016-04-30 22:30:16 +00:00
2017-03-20 14:49:11 +00:00
```sh
pip install pyblake2
2017-09-05 20:52:07 +00:00
2017-08-07 15:48:21 +00:00
brew install scons sdl2 sdl2_image
2017-09-05 20:52:07 +00:00
2016-06-03 14:16:07 +00:00
make build_unix
2016-04-30 22:30:16 +00:00
```
2016-06-03 14:16:07 +00:00
### Windows
Not supported yet ...
2016-09-29 10:37:52 +00:00
2017-03-20 14:49:11 +00:00
## Build instructions for ARM
2016-09-29 10:37:52 +00:00
2017-03-20 14:49:11 +00:00
### Linux
2016-09-29 10:37:52 +00:00
2017-09-27 12:04:43 +00:00
For flashing firmware to blank device (without bootloader) use `make flash`,
or `make flash STLINK_VER=v2-1` if using a ST-LINK/V2.1 interface.
2017-03-20 14:49:11 +00:00
#### Debian/Ubuntu
2016-09-29 10:37:52 +00:00
2017-03-20 14:49:11 +00:00
```sh
sudo pip install pyblake2
2017-09-05 20:52:07 +00:00
2016-09-29 10:37:52 +00:00
sudo apt-get install gcc-arm-none-eabi libnewlib-arm-none-eabi
2017-09-05 20:52:07 +00:00
make build_boardloader build_bootloader build_firmware
2016-09-29 10:37:52 +00:00
```
2016-10-17 15:32:06 +00:00
2017-03-20 14:49:11 +00:00
### OS X
2016-10-17 15:32:06 +00:00
2016-11-08 17:35:01 +00:00
1. Download [gcc-arm-none-eabi](https://launchpad.net/gcc-arm-embedded/5.0/5-2016-q3-update/)
2. Follow the [install instructions](https://launchpadlibrarian.net/287100883/readme.txt)
3. To install stlink, run `brew install stlink`
2017-09-05 20:52:07 +00:00
4. Run `make build_boardloader build_bootloader build_firmware`