mirror of
https://github.com/trezor/trezor-firmware.git
synced 2024-11-22 15:38:11 +00:00
docs: reorganize files
This commit is contained in:
Pavol Rusnak
parent
15b926dbbd
commit
dcb09012fb
100
README.md
100
README.md
@ -9,97 +9,9 @@ This is the source code for 2nd generation of TREZOR called TREZOR model T.
|
|||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
* [Documentation](docs/)
|
* [API](docs/api.md)
|
||||||
|
* [Build instructions](docs/build.md)
|
||||||
## Build instructions for emulator
|
* [Bootloader](docs/bootloader.md)
|
||||||
|
* [Hardware](docs/hardware.md)
|
||||||
Run the following to checkout the project:
|
* [Memory Layout](docs/memory.md)
|
||||||
|
* [TOIF Image Format](docs/toif.md)
|
||||||
```sh
|
|
||||||
git clone --recursive https://github.com/trezor/trezor-core.git
|
|
||||||
cd trezor-core
|
|
||||||
```
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
#### Debian/Ubuntu
|
|
||||||
|
|
||||||
```sh
|
|
||||||
sudo pip3 install --no-cache-dir pyblake2
|
|
||||||
|
|
||||||
sudo dpkg --add-architecture i386
|
|
||||||
sudo apt-get update
|
|
||||||
sudo apt-get install scons libsdl2-dev:i386 libsdl2-image-dev:i386 gcc-multilib
|
|
||||||
|
|
||||||
make build_unix
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Fedora
|
|
||||||
|
|
||||||
```sh
|
|
||||||
sudo pip3 install --no-cache-dir pyblake2
|
|
||||||
|
|
||||||
sudo yum install scons SDL2-devel.i686 SDL2_image-devel.i686
|
|
||||||
|
|
||||||
make build_unix
|
|
||||||
```
|
|
||||||
|
|
||||||
#### openSUSE
|
|
||||||
|
|
||||||
```sh
|
|
||||||
sudo pip3 install --no-cache-dir pyblake2
|
|
||||||
|
|
||||||
sudo zypper install scons libSDL2-devel-32bit libSDL2_image-devel-32bit
|
|
||||||
|
|
||||||
make build_unix
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Arch
|
|
||||||
|
|
||||||
```sh
|
|
||||||
sudo pip3 install --no-cache-dir pyblake2
|
|
||||||
|
|
||||||
sudo pacman -S gcc-multilib scons lib32-sdl2 lib32-sdl2_image
|
|
||||||
|
|
||||||
make build_unix
|
|
||||||
```
|
|
||||||
|
|
||||||
### OS X
|
|
||||||
|
|
||||||
```sh
|
|
||||||
pip3 install --no-cache-dir pyblake2
|
|
||||||
|
|
||||||
brew install scons sdl2 sdl2_image
|
|
||||||
|
|
||||||
make build_unix
|
|
||||||
```
|
|
||||||
|
|
||||||
### Windows
|
|
||||||
|
|
||||||
Not supported yet ...
|
|
||||||
|
|
||||||
## Build instructions for ARM
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
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.
|
|
||||||
You need to have OpenOCD installed.
|
|
||||||
|
|
||||||
#### Debian/Ubuntu
|
|
||||||
|
|
||||||
```sh
|
|
||||||
sudo pip3 install --no-cache-dir click pyblake2 scons
|
|
||||||
sudo pip3 install --no-deps git+https://github.com/trezor/python-trezor.git@master
|
|
||||||
|
|
||||||
sudo apt-get install gcc-arm-none-eabi libnewlib-arm-none-eabi
|
|
||||||
|
|
||||||
make vendorheader build_boardloader build_bootloader build_firmware
|
|
||||||
```
|
|
||||||
|
|
||||||
### OS X
|
|
||||||
|
|
||||||
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 OpenOCD, run `brew install open-ocd`
|
|
||||||
4. Run `make vendorheader build_boardloader build_bootloader build_firmware`
|
|
||||||
|
|||||||
@ -1,9 +0,0 @@
|
|||||||
# TREZOR Core documentation
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* [TREZOR Core API](api.md)
|
|
||||||
* [TREZOR Core Bootloader](bootloader.md)
|
|
||||||
* [TREZOR Core Image Format](toif.md)
|
|
||||||
* [TREZOR Core Memory Layout](memory.md)
|
|
||||||
* [TREZOR Core Hardware](hardware.md)
|
|
||||||
94
docs/build.md
Normal file
94
docs/build.md
Normal file
@ -0,0 +1,94 @@
|
|||||||
|
# Build instructions
|
||||||
|
|
||||||
|
## Build instructions for Emulator (Unix port)
|
||||||
|
|
||||||
|
Run the following to checkout the project:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone --recursive https://github.com/trezor/trezor-core.git
|
||||||
|
cd trezor-core
|
||||||
|
```
|
||||||
|
|
||||||
|
### Linux
|
||||||
|
|
||||||
|
#### Debian/Ubuntu
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo pip3 install --no-cache-dir pyblake2
|
||||||
|
|
||||||
|
sudo dpkg --add-architecture i386
|
||||||
|
sudo apt-get update
|
||||||
|
sudo apt-get install scons libsdl2-dev:i386 libsdl2-image-dev:i386 gcc-multilib
|
||||||
|
|
||||||
|
make build_unix
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Fedora
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo pip3 install --no-cache-dir pyblake2
|
||||||
|
|
||||||
|
sudo yum install scons SDL2-devel.i686 SDL2_image-devel.i686
|
||||||
|
|
||||||
|
make build_unix
|
||||||
|
```
|
||||||
|
|
||||||
|
#### openSUSE
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo pip3 install --no-cache-dir pyblake2
|
||||||
|
|
||||||
|
sudo zypper install scons libSDL2-devel-32bit libSDL2_image-devel-32bit
|
||||||
|
|
||||||
|
make build_unix
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Arch
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo pip3 install --no-cache-dir pyblake2
|
||||||
|
|
||||||
|
sudo pacman -S gcc-multilib scons lib32-sdl2 lib32-sdl2_image
|
||||||
|
|
||||||
|
make build_unix
|
||||||
|
```
|
||||||
|
|
||||||
|
### OS X
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pip3 install --no-cache-dir pyblake2
|
||||||
|
|
||||||
|
brew install scons sdl2 sdl2_image
|
||||||
|
|
||||||
|
make build_unix
|
||||||
|
```
|
||||||
|
|
||||||
|
### Windows
|
||||||
|
|
||||||
|
Not supported yet ...
|
||||||
|
|
||||||
|
## Build instructions for Embedded (ARM port)
|
||||||
|
|
||||||
|
### Linux
|
||||||
|
|
||||||
|
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.
|
||||||
|
You need to have OpenOCD installed.
|
||||||
|
|
||||||
|
#### Debian/Ubuntu
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo pip3 install --no-cache-dir click pyblake2 scons
|
||||||
|
sudo pip3 install --no-deps git+https://github.com/trezor/python-trezor.git@master
|
||||||
|
|
||||||
|
sudo apt-get install gcc-arm-none-eabi libnewlib-arm-none-eabi
|
||||||
|
|
||||||
|
make vendorheader build_boardloader build_bootloader build_firmware
|
||||||
|
```
|
||||||
|
|
||||||
|
### OS X
|
||||||
|
|
||||||
|
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 OpenOCD, run `brew install open-ocd`
|
||||||
|
4. Run `make vendorheader build_boardloader build_bootloader build_firmware`
|
||||||
Loading…
Reference in New Issue
Block a user