summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPatrick Vacek <patrickvacek@gmail.com>2019-09-05 17:17:05 +0200
committerPatrick Vacek <patrickvacek@gmail.com>2019-09-11 15:46:57 +0200
commitb81f7958398b7de2e317808c35a3717e6e027eba (patch)
tree9d644a8a16a11d2e44608f0841a6ed4ece692bf7
parente5478daf9f678f7281fe9cf7c211fc57eba65585 (diff)
downloadmeta-updater-b81f7958398b7de2e317808c35a3717e6e027eba.tar.gz
Restore basic doc about getting started and dependencies.
Signed-off-by: Patrick Vacek <patrickvacek@gmail.com>
-rw-r--r--README.adoc18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc
index af3d2ff..787aaf6 100644
--- a/README.adoc
+++ b/README.adoc
@@ -9,6 +9,24 @@ https://github.com/ostreedev/ostree[OSTree] is a tool for atomic full file syste
9 9
10https://github.com/advancedtelematic/aktualizr[Aktualizr] (and https://github.com/advancedtelematic/rvi_sota_client[RVI SOTA client]) add authentication and provisioning capabilities to OTA and are integrated with OSTree. You can connect with these open-source applications or sign up for a free account at https://connect.ota.here.com/[HERE OTA Connect] to get started. 10https://github.com/advancedtelematic/aktualizr[Aktualizr] (and https://github.com/advancedtelematic/rvi_sota_client[RVI SOTA client]) add authentication and provisioning capabilities to OTA and are integrated with OSTree. You can connect with these open-source applications or sign up for a free account at https://connect.ota.here.com/[HERE OTA Connect] to get started.
11 11
12== Quickstart
13
14If you don't already have a Yocto project that you want to add OTA to, you can use the xref:dev@getstarted::raspberry-pi.adoc[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.
15
16== Dependencies
17
18In 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:
19
20....
21sudo apt install cpu-checker default-jre parted
22....
23
24To 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:
25
26....
27sudo apt install ovmf
28....
29
12[discrete] 30[discrete]
13== Table of Contents 31== Table of Contents
14 32