trezor-firmware/README.md

![TREZOR Core](docs/trezor_core.png)

[![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)

This is the core of the upcoming TREZOR v2. It consists of several parts:

* patched version of [MicroPython](https://github.com/micropython/micropython) - in `vendor/micropython`
* application logic - in `src`

##Documentation

* [Documentation](docs/)

##Build instructions for emulator

###Linux

####Debian/Ubuntu

```
sudo dpkg --add-architecture i386
sudo apt-get update
sudo apt-get install libsdl2-dev:i386 libsdl2-image-dev:i386
make build_unix
```

####Fedora

```
sudo yum install SDL2-devel.i686 SDL2_image-devel.i686
make build_unix
```

####openSUSE

```
sudo zypper install libSDL2-devel-32bit libSDL2_image-devel-32bit
make build_unix
```

###OS X

```
brew install --universal sdl2 sdl2_image
make build_unix
```

### Windows

Not supported yet ...

##Build instructions for ARM

###Linux

For flashing firmware to blank device (without bootloader) by `make flash`, please install [stlink](https://github.com/texane/stlink)

####Debian/Ubuntu

```
sudo apt-get install gcc-arm-none-eabi libnewlib-arm-none-eabi
make build_stmhal_frozen
```

###OS X

Download [gcc-arm-none-eabi](https://launchpad.net/gcc-arm-embedded/5.0/5-2016-q3-update/) and follow the [instructions in readme.txt](https://launchpadlibrarian.net/287100883/readme.txt).
To install stlink, run `brew install stlink`.
cleanup 2016-10-05 17:45:09 +00:00			`![TREZOR Core](docs/trezor_core.png)`
init 2016-02-01 10:52:57 +00:00
add travis tests 2016-10-03 14:32:58 +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)`

add more info to readme 2016-10-07 12:41:21 +00:00			`This is the core of the upcoming TREZOR v2. It consists of several parts:`

			* patched version of [MicroPython](https://github.com/micropython/micropython) - in `vendor/micropython`
			* application logic - in `src`

docs: fix table 2016-10-10 10:32:38 +00:00			`##Documentation`

add logo 2016-02-01 16:25:52 +00:00			`* [Documentation](docs/)`
add build instructions 2016-04-30 22:30:16 +00:00
Added instructions for ARM on Ubuntu 2016-09-29 10:37:52 +00:00			`##Build instructions for emulator`
add build instructions 2016-04-30 22:30:16 +00:00
			`###Linux`

update build instructions 2016-06-03 14:16:07 +00:00			`####Debian/Ubuntu`

add build instructions 2016-04-30 22:30:16 +00:00			```
add note about adding 32bit arch to Debian/Ubuntu 2016-10-03 18:20:59 +00:00			`sudo dpkg --add-architecture i386`
			`sudo apt-get update`
add possibility to save screen to png using ui.display.save() (unix port only) 2016-10-05 22:02:46 +00:00			`sudo apt-get install libsdl2-dev:i386 libsdl2-image-dev:i386`
add build instructions 2016-04-30 22:30:16 +00:00			`make build_unix`
			```

update build instructions 2016-06-03 14:16:07 +00:00			`####Fedora`

			```
add possibility to save screen to png using ui.display.save() (unix port only) 2016-10-05 22:02:46 +00:00			`sudo yum install SDL2-devel.i686 SDL2_image-devel.i686`
update build instructions 2016-06-03 14:16:07 +00:00			`make build_unix`
			```

			`####openSUSE`

			```
add possibility to save screen to png using ui.display.save() (unix port only) 2016-10-05 22:02:46 +00:00			`sudo zypper install libSDL2-devel-32bit libSDL2_image-devel-32bit`
update build instructions 2016-06-03 14:16:07 +00:00			`make build_unix`
			```

add build instructions 2016-04-30 22:30:16 +00:00			`###OS X`

			```
add possibility to save screen to png using ui.display.save() (unix port only) 2016-10-05 22:02:46 +00:00			`brew install --universal sdl2 sdl2_image`
update build instructions 2016-06-03 14:16:07 +00:00			`make build_unix`
add build instructions 2016-04-30 22:30:16 +00:00			```
update build instructions 2016-06-03 14:16:07 +00:00
			`### Windows`

			`Not supported yet ...`
Added instructions for ARM on Ubuntu 2016-09-29 10:37:52 +00:00
			`##Build instructions for ARM`

			`###Linux`

add more info to readme 2016-10-07 12:41:21 +00:00			For flashing firmware to blank device (without bootloader) by `make flash`, please install [stlink](https://github.com/texane/stlink)
Updated instructions for ARM build (on Linux). 2016-09-29 11:35:24 +00:00
Added instructions for ARM on Ubuntu 2016-09-29 10:37:52 +00:00			`####Debian/Ubuntu`

			```
			`sudo apt-get install gcc-arm-none-eabi libnewlib-arm-none-eabi`
readme: os x ARM instructions 2016-10-17 15:32:06 +00:00			`make build_stmhal_frozen`
Added instructions for ARM on Ubuntu 2016-09-29 10:37:52 +00:00			```
readme: os x ARM instructions 2016-10-17 15:32:06 +00:00
			`###OS X`

			`Download [gcc-arm-none-eabi](https://launchpad.net/gcc-arm-embedded/5.0/5-2016-q3-update/) and follow the [instructions in readme.txt](https://launchpadlibrarian.net/287100883/readme.txt).`
			To install stlink, run `brew install stlink`.