Skip to content

Commit 8ae64c1

Browse files
pfalcongalak
authored andcommitted
README: Update to current state of affairs.
Replaces outdated information with more up-to-date/generic, fixing typos and formatting issues on the way. Signed-off-by: Paul Sokolovsky <[email protected]>
1 parent 08bc1e8 commit 8ae64c1

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22

33
This project is to replace the previous Yocto based SDK with a new framework for
44
building the Zephyr SDK using [crosstool-ng](https://crosstool-ng.github.io/).
5+
(Some tools are still built using Yocto/Bitbake).
56

6-
The repository consists of configurations for the various architectures (not
7-
fully tests) and a script that builds on Linux (x86_64) and Mac in a consistent
8-
way, apply patches where needed.
7+
The repository consists of configurations for the various architectures (not all
8+
fully tested) and a script that builds on Linux (x86_64) and Mac in a consistent
9+
way, applying patches where needed.
910

1011
Currently we build the following toolchains:
1112
- i586
@@ -26,28 +27,30 @@ To build for any of the above, run:
2627
./go.sh <arch>
2728
```
2829

29-
Production builds are done using the script in `.shippable.yml` which
30-
identifies some packages you'll need to have installed for the above
31-
command to work.
30+
Production builds are done using the scripts in `.buildkite/` and
31+
`.github/workflows/` which identify some packages you'll need to
32+
have installed for the above command to work.
3233

3334
When building locally be aware that `./go.sh` is written assuming it's
3435
invoked in a pristine workspace. That means if you pull an update of
35-
this repository `./go.sh` will not update the `crosstool-ng` source and
36-
rebuild the `bin/ct-ng` utility to match the update configuration. This
36+
this repository `./go.sh` will not update the `crosstool-ng` source or
37+
rebuild the `bin/ct-ng` utility to match the updated configuration. This
3738
can produce very confusing results.
3839

3940
## Released Binaries packages
4041

41-
Pre-built binaries releases of the SDK are made and currently only available for
42-
an x86_64 Linux host environment. The releases can be found here:
42+
Pre-built binary releases of the SDK are made for a few OSes and host
43+
architectures. They can be found here:
4344

4445
https://github.com/zephyrproject-rtos/sdk-ng/releases
4546

4647
## PR Builds
4748

4849
Successfull PR builds will get posted here:
4950

50-
https://builds.zephyrproject.org/zephyrproject-rtos/sdk-ng/<PR NUMBER>/zephyr-sdk-<VERISON>-setup.run
51+
```
52+
https://builds.zephyrproject.org/zephyrproject-rtos/sdk-ng/<PR_NUMBER>/zephyr-sdk-<VERSION>-setup.run
53+
```
5154

5255
## Release Process
5356

@@ -57,5 +60,5 @@ To release a new SDK:
5760
0.11.0-beta1 etc.
5861
- On https://github.com/zephyrproject-rtos/sdk-ng/releases, create the release
5962
tag and add the release information.
60-
- One the release is created, CI will build the SDK image and will upload it to
63+
- Once the release is created, CI will build the SDK image and will upload it to
6164
the release page.

0 commit comments

Comments
 (0)