Skip to content

Commit 8b69525

Browse files
committed
docs: update README for SC598 bootstrap image
Signed-off-by: Ozan Durgut <ozan.durgut@analog.com>
1 parent 5f392a8 commit 8b69525

1 file changed

Lines changed: 38 additions & 8 deletions

File tree

readme.md

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,56 @@
11
# ADI br2-external
22

33
This [br2-external](https://buildroot.org/downloads/manual/manual.html#outside-br-custom)
4-
contains Buildroot configuration specific to ADI that can not be mainlined.
5-
Generic support for ADI evaluation boards is implemented in the [ADI Buildroot
6-
tree](github.com/analogdevicesinc/buildroot).
4+
contains Buildroot configuration specific to ADI that cannot be mainlined.
5+
Generic support for ADI evaluation boards is implemented in the
6+
[ADI Buildroot tree](github.com/analogdevicesinc/buildroot).
77

8-
```
8+
## Getting Started
9+
10+
```sh
911
git clone --recurse-submodules https://github.com/analogdevicesinc/br2-external.git
1012
cd br2-external/buildroot
1113
make BR2_EXTERNAL="${PWD}/.." adi_sc598_ezkit_defconfig
14+
```
15+
16+
Additional configuration is applied using Buildroot fragments:
17+
18+
```sh
1219
support/kconfig/merge_config.sh .config \
1320
../configs/buildroot.fragment \
14-
../configs/debug.fragment
21+
<ADI Configuration fragments>
1522
```
1623

17-
Then follow the board specific instructions in `buildroot/board/adi/`.
18-
19-
## ADI configuration
24+
## ADI Configuration Fragments
2025

2126
- `configs/buildroot.fragment`
2227
- Configure Buildroot to speed up builds
2328
- `configs/debug.fragment`
2429
- Enable debugging in U-Boot and the kernel
2530
- Build the kernel image with an embedded root filesystem to reduce
2631
complexity around writing and mounting a root filesystem from storage
32+
- `configs/bootstrap.fragment`
33+
- Enable a minimal bootstrap / installer image.
34+
- Includes only the tools required to program boot media.
35+
36+
## Example Builds
37+
38+
### Debug Image
39+
40+
```sh
41+
make BR2_EXTERNAL="${PWD}/.." adi_sc598_ezkit_defconfig
42+
support/kconfig/merge_config.sh .config \
43+
../configs/buildroot.fragment \
44+
../configs/debug.fragment
45+
make -j$(nproc)
46+
```
47+
48+
### Bootstrap Image
49+
50+
```sh
51+
make BR2_EXTERNAL="${PWD}/.." adi_sc598_ezkit_defconfig
52+
support/kconfig/merge_config.sh .config \
53+
../configs/buildroot.fragment \
54+
../configs/bootstrap.fragment
55+
make -j$(nproc)
56+
```

0 commit comments

Comments
 (0)