Skip to content

Commit 887cce0

Browse files
pabigotgalak
authored andcommitted
README: update with helpful developer information
Provide some clues to people who might want to try out SDK customizations. Signed-off-by: Peter A. Bigot <[email protected]>
1 parent 55b005b commit 887cce0

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Zephyr SDK with Crosstool NG
22

3-
This project is to replace the current Yocto based SDK with a new framework for
4-
building the Zephyr SDK using crosstool-ng.
3+
This project is to replace the previous Yocto based SDK with a new framework for
4+
building the Zephyr SDK using [crosstool-ng](https://crosstool-ng.github.io/).
55

6-
The repoistory consists of configurations for the various architectures (not
6+
The repository consists of configurations for the various architectures (not
77
fully tests) and a script that builds on Linux (x86_64) and Mac in a consistent
88
way, apply patches where needed.
99

@@ -23,6 +23,16 @@ To build for any of the above, run:
2323
./go.sh <arch>
2424
```
2525

26+
Production builds are done using the script in `.shippable.yml` which
27+
identifies some packages you'll need to have installed for the above
28+
command to work.
29+
30+
When building locally be aware that `./go.sh` is written assuming it's
31+
invoked in a pristine workspace. That means if you pull an update of
32+
this repository `./go.sh` will not update the `crosstool-ng` source and
33+
rebuild the `bin/ct-ng` utility to match the update configuration. This
34+
can produce very confusing results.
35+
2636
## Released Binaries packages
2737

2838
Pre-built binaries releases of the SDK are made and currently only available for

0 commit comments

Comments
 (0)