parent
e58225fe02
commit
e4077e0634
@ -1,25 +1,35 @@
|
||||
# Build
|
||||
|
||||
## New Project
|
||||
|
||||
Run the following to checkout the project:
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
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
|
||||
sudo pip3 install pipenv
|
||||
pipenv sync
|
||||
pipenv shell
|
||||
```
|
||||
|
Loading…
Reference in new issue