diff options
author | Patrick Vacek <patrickvacek@gmail.com> | 2019-09-17 09:32:11 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-09-17 09:32:11 +0200 |
commit | 0b7b83838324f23a4068bfe7ab54d18336779622 (patch) | |
tree | 11a6f2d3694e6d4e91f180ee5a870713f05cade4 | |
parent | a7629d5dbbb6f326f42bcad7a18eec068af7b356 (diff) | |
parent | 4a4fe0a6a8f3b6fecb7eceb5a1bbeabfc990d1d3 (diff) | |
download | meta-updater-0b7b83838324f23a4068bfe7ab54d18336779622.tar.gz |
Merge pull request #608 from advancedtelematic/docs/morty/supported-branches
Docs/morty/supported branches
-rw-r--r-- | CONTRIBUTING.adoc | 12 | ||||
-rw-r--r-- | README.adoc | 6 |
2 files changed, 6 insertions, 12 deletions
diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 4d9e8f6..dafa49c 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc | |||
@@ -1,15 +1,7 @@ | |||
1 | = Contributing | 1 | = Contributing |
2 | :aktualizr-docsroot: https://github.com/advancedtelematic/aktualizr/tree/master/docs/ota-client-guide/modules/ROOT/pages/ | ||
2 | 3 | ||
3 | We welcome pull requests from anyone. The master branch is the primary branch for development, and if you wish to add new functionality, it probably belongs there. We attempt to maintain recent previous branches and welcome bug fixes and backports for those. Currently, the actively maintained branches are: | 4 | We welcome pull requests from anyone. The master branch is the primary branch for development, and if you wish to add new functionality, it probably belongs there. We attempt to maintain recent release branches and welcome bug fixes and backports for those. Please see the xref:{aktualizr-docsroot}yocto-release-branches.adoc[release branches] documentation for the current list of supported branches. |
4 | |||
5 | * thud | ||
6 | * sumo | ||
7 | * rocko | ||
8 | |||
9 | Previously, some older branches were also regularly supported, and while they should still be stable, they have not been updated or actively maintained for a while. These branches include: | ||
10 | |||
11 | * pyro | ||
12 | * morty | ||
13 | 5 | ||
14 | If you are developing with meta-updater, it may be helpful to read the README and other documentation for link:README.adoc[this repo], https://github.com/advancedtelematic/aktualizr[aktualizr], and the https://github.com/advancedtelematic/updater-repo/[updater-repo], particularly the sections about development and debugging. | 6 | If you are developing with meta-updater, it may be helpful to read the README and other documentation for link:README.adoc[this repo], https://github.com/advancedtelematic/aktualizr[aktualizr], and the https://github.com/advancedtelematic/updater-repo/[updater-repo], particularly the sections about development and debugging. |
15 | 7 | ||
diff --git a/README.adoc b/README.adoc index 32630d7..ec5227b 100644 --- a/README.adoc +++ b/README.adoc | |||
@@ -2,12 +2,14 @@ | |||
2 | :toc: macro | 2 | :toc: macro |
3 | :toc-title: | 3 | :toc-title: |
4 | 4 | ||
5 | This layer enables over-the-air updates (OTA) with https://github.com/ostreedev/ostree[OSTree] and https://github.com/advancedtelematic/aktualizr[Aktualizr]. | 5 | Meta-updater is a link:https://www.yoctoproject.org/software-overview/layers/[Yocto layer] that enables over-the-air updates (OTA) with https://github.com/ostreedev/ostree[OSTree] and https://github.com/advancedtelematic/aktualizr[Aktualizr] -- the default client for link:https://www.here.com/products/automotive/ota-technology[HERE OTA Connect]. |
6 | 6 | ||
7 | https://github.com/ostreedev/ostree[OSTree] is a tool for atomic full file system upgrades with rollback capability. OSTree has several advantages over traditional dual-bank systems, but the most important one is that it minimizes network bandwidth and data storage footprint by sharing files with the same contents across file system deployments. | 7 | https://github.com/ostreedev/ostree[OSTree] is a tool for atomic full file system upgrades with rollback capability. OSTree has several advantages over traditional dual-bank systems, but the most important one is that it minimizes network bandwidth and data storage footprint by sharing files with the same contents across file system deployments. |
8 | 8 | ||
9 | https://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. | 9 | https://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. |
10 | 10 | ||
11 | For the most up-to-date documentation for HERE OTA Connect, meta-updater, and aktualizr, please visit our link:https://docs.ota.here.com/[documentation portal]. | ||
12 | |||
11 | [discrete] | 13 | [discrete] |
12 | == Table of Contents | 14 | == Table of Contents |
13 | 15 | ||
@@ -17,7 +19,7 @@ toc::[] | |||
17 | 19 | ||
18 | === Quickstart | 20 | === Quickstart |
19 | 21 | ||
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. | 22 | If you don't already have a Yocto project that you want to add OTA to, you can use the https://docs.ota.here.com/getstarted/dev/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 | 23 | ||
22 | === Adding meta-updater capabilities to your build | 24 | === Adding meta-updater capabilities to your build |
23 | 25 | ||