Skip to content

Commit 48dc282

Browse files
committed
docs/QUICK_START.md: document bitbake-setup usage
Also make some small reorganizations to the file so that all of the setup sections are more readable and consistent with formatting. Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
1 parent 1f35296 commit 48dc282

1 file changed

Lines changed: 38 additions & 3 deletions

File tree

docs/QUICK_START.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,46 @@
44

55
Make sure to [install the `repo` command by Google](https://gerrit.googlesource.com/git-repo#install) first.
66

7-
## Create workspace
7+
## bitbake-setup
8+
9+
The following examples assumes that you have the `bitbake` repository checked
10+
out at `~/workspace/yocto/bitbake`, and that you are using the `nodistro`
11+
variant. They read the config templates from URLs to minimize how much needs to
12+
be preemptively checked out on the host system. Alternatively, you could clone
13+
this repository and use the following to achieve the same result:
14+
15+
```
16+
../bitbake-setup init /path/to/meta-riscv/bitbake-regsitry/your-preferred.conf.json
17+
```
18+
19+
### Interactively
20+
21+
1. `~/workspace/yocto/bitbake/bin/bitbake-setup init https://raw.githubusercontent.com/riscv/meta-riscv/refs/heads/master/bitbake-registry/meta-riscv-oe-nodistro-master.conf.json`
22+
2. Provide your choice of MACHINE
23+
3. Set the workspace name
24+
4. Confirm workspace setup
25+
26+
bitbake-setup should clone the minimal repository set and provide you with
27+
further usage instructions.
28+
29+
### Non-Interactively
30+
31+
Using `MACHINE="orangepi-rv2"` as an example:
32+
33+
```
34+
bitbake-setup init --non-interactive https://raw.githubusercontent.com/riscv/meta-riscv/refs/heads/master/bitbake-registry/meta-riscv-oe-nodistro-master.conf.json nodistro machine/orangepi-r2s
35+
```
36+
37+
## repo
38+
39+
### Create workspace
840
```text
941
mkdir riscv-yocto && cd riscv-yocto
1042
repo init -u https://github.com/riscv/meta-riscv -b master -m tools/manifests/riscv-yocto.xml
1143
repo sync
1244
repo start work --all
1345
```
14-
## Update existing workspace
46+
### Update existing workspace
1547

1648
In order to bring all the layers up to date with upstream
1749

@@ -21,7 +53,10 @@ repo sync
2153
repo rebase
2254
```
2355

24-
## Setup Build Environment
56+
## envsetup script
57+
58+
Set up the build environment:
59+
2560
```text
2661
. layers/meta-riscv/tools/envsetup.sh
2762
```

0 commit comments

Comments
 (0)