Skip to content

Commit ab629ba

Browse files
authored
Merge pull request #42 from dgarske/install
Added basic instructions for getting started
2 parents 46058f0 + 99a0ce8 commit ab629ba

1 file changed

Lines changed: 68 additions & 0 deletions

File tree

INSTALL.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# wolfBoot Setup Instructions
2+
3+
## Gathering Sources
4+
5+
### Git Command Line
6+
7+
```sh
8+
git clone https://github.com/wolfSSL/wolfBoot.git
9+
cd wolfBoot
10+
git submodule init
11+
git submodule update
12+
```
13+
14+
### Using browser only
15+
16+
Download these:
17+
https://github.com/wolfSSL/wolfBoot/archive/master.zip
18+
https://github.com/wolfSSL/wolfssl/archive/master.zip
19+
20+
1. Extract wolfBoot
21+
2. `cd wolfBoot/lib`
22+
3. Extact wolfSSL (should be named `lib/wolfssl`)
23+
24+
Directory should look like:
25+
26+
```
27+
wolfBoot
28+
-> config
29+
-> docs
30+
-> hal
31+
-> IDE
32+
-> include
33+
-> lib
34+
-> wolfssl
35+
-> src
36+
-> wolfcrypt/src
37+
-> src
38+
-> test-app
39+
-> tools
40+
```
41+
42+
## Configuration
43+
44+
Use `make config` to walk-through setting up the platform, architecture and partition settings.
45+
OR
46+
Use the `config/examples` as a template to wolfBoot root as `.config`.
47+
Example: `cp ./config/examples/zynqmp.config .config`
48+
49+
## Setup the Key
50+
51+
Use the key generation tool in `tools/keytool` or get existing keys.
52+
Copy `rsa4096.der` to wolfBoot root
53+
Copy `rsa4096_pub_key.c` to `./src`
54+
55+
## Building
56+
57+
```sh
58+
make
59+
```
60+
61+
## Building with Cross Compile
62+
63+
QNX Example:
64+
65+
```sh
66+
source ~/qnx700/qnxsdp-env.sh
67+
make CROSS_COMPILE=aarch64-unknown-nto-qnx7.0.0-
68+
```

0 commit comments

Comments
 (0)