diff options
author | Patrick Vacek <patrickvacek@gmail.com> | 2019-06-17 16:02:07 +0200 |
---|---|---|
committer | Patrick Vacek <patrickvacek@gmail.com> | 2019-06-17 16:24:33 +0200 |
commit | 9b5a1aa72d7f38e257c49cd137d82f23176a3d59 (patch) | |
tree | fa4184ed3b5d5e46dd1a962d10cdb7a6a6e8f662 | |
parent | 4af32c3d2b1ad79cb8e7fbefd4ddeb648f06c4d7 (diff) | |
download | meta-updater-9b5a1aa72d7f38e257c49cd137d82f23176a3d59.tar.gz |
Add dependencies section.
This can be found in the quickstart guide but is worth putting front and
center here, especially for the things we don't mention in the
quickstart.
Signed-off-by: Patrick Vacek <patrickvacek@gmail.com>
-rw-r--r-- | README.adoc | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/README.adoc b/README.adoc index 41d8e96..4cb0cbf 100644 --- a/README.adoc +++ b/README.adoc | |||
@@ -19,6 +19,20 @@ toc::[] | |||
19 | 19 | ||
20 | If you don't already have a Yocto project that you want to add OTA to, you can use the https://docs.atsgarage.com/quickstarts/raspberry-pi.html[HERE OTA Connect Quickstart] project to rapidly get up and running on a Raspberry Pi. It takes a standard https://www.yoctoproject.org/tools-resources/projects/poky[poky] distribution, and adds OTA and OSTree capabilities. | 20 | If you don't already have a Yocto project that you want to add OTA to, you can use the https://docs.atsgarage.com/quickstarts/raspberry-pi.html[HERE OTA Connect Quickstart] project to rapidly get up and running on a Raspberry Pi. It takes a standard https://www.yoctoproject.org/tools-resources/projects/poky[poky] distribution, and adds OTA and OSTree capabilities. |
21 | 21 | ||
22 | === Dependencies | ||
23 | |||
24 | In addition to the link:https://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#required-packages-for-the-build-host[standard Yocto dependencies], meta-updater generally requires a few additional dependencies, depending on your use case and target platform. To install these additional packages on Debian/Ubuntu, run this: | ||
25 | |||
26 | .... | ||
27 | sudo apt install cpu-checker default-jre parted | ||
28 | .... | ||
29 | |||
30 | To build for https://github.com/advancedtelematic/meta-updater-minnowboard[Minnowboard] with GRUB, you will also need to install https://github.com/tianocore/tianocore.github.io/wiki/OVMF[TianoCore's ovmf] package on your host system. On Debian/Ubuntu, you can do so with this command: | ||
31 | |||
32 | .... | ||
33 | sudo apt install ovmf | ||
34 | .... | ||
35 | |||
22 | === Adding meta-updater capabilities to your build | 36 | === Adding meta-updater capabilities to your build |
23 | 37 | ||
24 | If you already have a Yocto-based project and you want to add atomic filesystem updates to it, you just need to do three things: | 38 | If you already have a Yocto-based project and you want to add atomic filesystem updates to it, you just need to do three things: |
@@ -72,7 +86,7 @@ If your board isn't supported yet, you can add board integration code yourself. | |||
72 | 86 | ||
73 | You may take a look into https://github.com/advancedtelematic/meta-updater-minnowboard[Minnowboard] or https://github.com/advancedtelematic/meta-updater-raspberrypi[Raspberry Pi] integration layers for examples. | 87 | You may take a look into https://github.com/advancedtelematic/meta-updater-minnowboard[Minnowboard] or https://github.com/advancedtelematic/meta-updater-raspberrypi[Raspberry Pi] integration layers for examples. |
74 | 88 | ||
75 | Although we have used U-Boot so far, other boot loaders can be configured work with OSTree as well. | 89 | Although we have focused on U-Boot and GRUB so far, other bootloaders can be configured to work with OSTree as well. |
76 | 90 | ||
77 | Your images will also need network connectivity to be able to reach an actual OTA backend. Our 'poky-sota' distribution does not mandate or install a default network manager but our supported platforms use the `virtual/network-configuration` recipe, which can be used as a starting example. | 91 | Your images will also need network connectivity to be able to reach an actual OTA backend. Our 'poky-sota' distribution does not mandate or install a default network manager but our supported platforms use the `virtual/network-configuration` recipe, which can be used as a starting example. |
78 | 92 | ||
@@ -220,11 +234,7 @@ IMAGE_INSTALL_append = " dropbear " | |||
220 | 234 | ||
221 | 3. Some tests require that `SOTA_PACKED_CREDENTIALS` is set in your `conf/local.conf`. See the <<sota-related-variables-in-localconf,SOTA-related variables in local.conf>> section. | 235 | 3. Some tests require that `SOTA_PACKED_CREDENTIALS` is set in your `conf/local.conf`. See the <<sota-related-variables-in-localconf,SOTA-related variables in local.conf>> section. |
222 | 236 | ||
223 | 4. To be able to build an image for the grub tests, you will need to install https://github.com/tianocore/tianocore.github.io/wiki/OVMF[TianoCore's ovmf] package on your host system. On Debian-like systems, you can do so with this command: | 237 | 4. To be able to build an image for the GRUB tests, you will need to install the ovmf package as described in the <<Dependencies,dependencies>>. |
224 | + | ||
225 | ``` | ||
226 | sudo apt install ovmf | ||
227 | ``` | ||
228 | 238 | ||
229 | 5. Run oe-selftest: | 239 | 5. Run oe-selftest: |
230 | + | 240 | + |