arno/trezor-firmware
1
0
Fork 0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-12-23 14:58:09 +00:00
Code Issues Releases Wiki Activity

docs/core: improve build section

Browse Source
This commit is contained in:
Tomas Susanka 2020-02-10 13:05:41 +01:00
parent e58225fe02
commit e4077e0634
3 changed files with 33 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/core/build/embedded.md
View File

@ -1,6 +1,7 @@
# Build instructions for Embedded (ARM port) # Build instructions for Embedded (ARM port)
First clone, initialize submodules and install Pipenv as defined [here](index.md). First clone, initialize submodules and install Pipenv as defined [here](index.md).
**Do not forget you need to be in a `pipenv shell` environment!**
## Requirements ## Requirements
@ -13,17 +14,26 @@ You will also need Python dependencies for signing.
sudo apt-get install scons gcc-arm-none-eabi libnewlib-arm-none-eabi sudo apt-get install scons gcc-arm-none-eabi libnewlib-arm-none-eabi
``` ```
### NixOS
There is a `shell.nix` file in the root of the project. Just run the following
**before** entering the `core` directory:
```sh
nix-shell
```
### OS X ### OS X
1. Download [gcc-arm-none-eabi](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads) 1. Download [gcc-arm-none-eabi](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads)
2. Follow the [install instructions](https://launchpadlibrarian.net/287100883/readme.txt) 2. Follow the [install instructions](https://launchpadlibrarian.net/287100883/readme.txt)
3. To install OpenOCD, run `brew install open-ocd` 3. To install OpenOCD, run `brew install open-ocd`
4. Run `pipenv run make vendor build_boardloader build_bootloader build_firmware` 4. Run `make vendor build_boardloader build_bootloader build_firmware`
## Building ## Building
```sh ```sh
pipenv run make vendor build_boardloader build_bootloader build_firmware make vendor build_boardloader build_bootloader build_firmware
``` ```
## Uploading ## Uploading
@ -41,7 +51,7 @@ You need to have OpenOCD installed.
You can also build firmware in debug mode to see log output or run tests. You can also build firmware in debug mode to see log output or run tests.
```sh ```sh
PYOPT=0 pipenv run make build_firmware PYOPT=0 make build_firmware
``` ```
You can then use `screen` to enter the device's console. Do not forget to add your user to the `dialout` group or use `sudo`. Note that both the group and the tty name can differ, use `ls -l` to find out proper names on your machine. You can then use `screen` to enter the device's console. Do not forget to add your user to the `dialout` group or use `sudo`. Note that both the group and the tty name can differ, use `ls -l` to find out proper names on your machine.

6
docs/core/build/emulator.md
View File

@ -1,6 +1,8 @@
# Build instructions for Emulator (Unix port) # Build instructions for Emulator (Unix port)
First clone, initialize submodules and install Pipenv as defined [here](index.md). First clone, initialize submodules, install Pipenv and enter the Pipenv shell as
defined [here](index.md). **Do not forget you need to be in a `pipenv shell`
environment!**
## Dependencies ## Dependencies
@ -51,7 +53,7 @@ brew install scons sdl2 sdl2_image pkg-config
Run the build with: Run the build with:
```sh ```sh
pipenv run make build_unix make build_unix
``` ```
## Run ## Run

22
docs/core/build/index.md
View File

@ -1,25 +1,35 @@
# Build # Build
## New Project
Run the following to checkout the project: Run the following to checkout the project:
```sh ```sh
git clone --recursive https://github.com/trezor/trezor-firmware.git git clone --recurse-submodules https://github.com/trezor/trezor-firmware.git
cd trezor-firmware/core cd trezor-firmware/core
``` ```
If you are building from an existing checkout, don't forget to use the following to refresh the submodules: After this you will need to install some software dependencies based on what flavor
of Core you want to build. You can either build the Emulator or the actual firmware
running on ARM devices. Emulator (also called _unix_ port) is a unix version that can
run on your computer. See [Emulator](../emulator/index.md) for more information.
## Existing Project
If you are building from an existing checkout, do not forget to refresh the submodules
and the pipenv environment:
```sh ```sh
make vendor git submodule update --init --recursive --force
pipenv sync
``` ```
After this you will need to install some software dependencies based on what flavor of Core you want to build. You can either build the Emulator or the actual firmware running on ARM devices. Emulator (also called _unix_ port) is a unix version that can run on your computer. See [Emulator](../emulator/index.md) for more information.
## Pipenv ## Pipenv
We use [Pipenv](https://docs.pipenv.org/en/latest/) to install and track Python dependencies. You need to install it, sync the packages and then use `pipenv run` for every command or enter `pipenv shell` before typing any commands. We use [Pipenv](https://docs.pipenv.org/en/latest/) to install and track Python dependencies. You need to install it, sync the packages and then use `pipenv run` for every command or enter `pipenv shell` before typing any commands. **The commands in this section suppose you are in a `pipenv shell` environment!**
```sh ```sh
sudo pip3 install pipenv sudo pip3 install pipenv
pipenv sync pipenv sync
pipenv shell
``` ```