Skip to content

Commit 94393b3

Browse files
Updates to README before release (#104)
* Updates to README before release * Apply suggestions from code review Co-authored-by: Mattias Axelsson <[email protected]> --------- Co-authored-by: Mattias Axelsson <[email protected]>
1 parent bf48726 commit 94393b3

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
[![Lint codebase](https://github.com/AxisCommunications/acap-runtime/actions/workflows/lint.yml/badge.svg)](https://github.com/AxisCommunications/acap-runtime/actions/workflows/lint.yml)
77
[![CI/CD](https://github.com/AxisCommunications/acap-runtime/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/AxisCommunications/acap-runtime/actions/workflows/ci-cd.yml)
8+
[![Proto build](https://github.com/AxisCommunications/acap-runtime/actions/workflows/build-proto-image.yml/badge.svg)](https://github.com/AxisCommunications/acap-runtime/actions/workflows/build-proto-image.yml)
89

910
ACAP Runtime is a network protocol based service, using [gRPC][gRPC].
1011
This makes the service available to clients written in different languages on
@@ -13,10 +14,18 @@ the same device. ACAP Runtime is also described in the [ACAP documentation][acap
1314
If you are new to the world of ACAPs take a moment to check out
1415
[What is ACAP?][acap-documentation]
1516

17+
<!-- omit in toc -->
18+
## Notable Releases
19+
<!-- markdownlint-disable MD013 -->
20+
| Release | AXIS OS min. version | Comment |
21+
| -----------------------: | -------------------: |---------------------------------|
22+
| [2.0.0][latest-release] | 11.10 | Latest release |
23+
| [1.3.1][1.3.1-release] | 10.12 | Legacy release AXIS OS 2022 LTS |
24+
1625
> [!NOTE]
1726
>
18-
> Up until release v1.3.1 ACAP Runtime was distributed both as an ACAP Application eap-file and as a Docker Image.
19-
> All comming releases will be done only as Docker Images.
27+
> Up until release 1.3.1 ACAP Runtime was distributed both in the form of an ACAP application eap-file and as a Docker image.
28+
> From release 2.0.0 and onwards ACAP Runtime will be distributed as a Docker image only.
2029
2130
<!-- omit in toc -->
2231
## Table of contents
@@ -53,7 +62,7 @@ A client for the ACAP Runtime gRPC server could be developed either using the
5362
[ACAP Computer Vision SDK][acap-documentation-cv]. See the [Examples](#examples)
5463
section for examples of how ACAP Runtime is used together with ACAP Computer Vision SDK.
5564

56-
> **Note**
65+
> [!NOTE]
5766
>
5867
> The ACAP Runtime service can run with TLS authentication or without.
5968
> Be aware that running without TLS authentication is extremely insecure and we
@@ -66,8 +75,8 @@ authentication when using ACAP Runtime.
6675
The following requirements need to be met.
6776

6877
- Axis device:
69-
- [Docker ACAP][docker-acap] or [Docker Compose ACAP][docker-compose-acap] installed and running.
70-
- AXIS OS version 10.12 or higher.
78+
- [Docker ACAP][docker-acap] or [Docker Compose ACAP][docker-compose-acap] version 2.0.0 or higher, installed and running.
79+
- AXIS OS version 11.10 or higher.
7180
- Certificate files if [TLS](#tls) is used.
7281

7382
- Computer:
@@ -255,7 +264,7 @@ where `<ARCH>` is either `armv7hf` or `aarch64`.
255264

256265
## Building protofiles for Python
257266

258-
The repository includes a Dockerfile (`Dockerfile.proto`) for building the APIs protofiles for Python. The Dockerfile generates the necessary Python files from the protobuf definitions, allowing gRPC communication with the ACAP Runtime service. This means that applications can copy these prebuilt files from ACAP Runtime container image instead of having to build the protofiles themselves.
267+
The repository includes a Dockerfile (`Dockerfile.proto`) for building the APIs protofiles for Python. The Dockerfile generates the necessary Python files from the protobuf definitions, allowing gRPC communication with the ACAP Runtime service. This means that applications can copy these prebuilt files from `axisecp/acap-runtime:<Release version>-protofiles` image instead of having to build the protofiles themselves.
259268

260269
To build the protofiles:
261270

@@ -308,6 +317,7 @@ Take a look at the [CONTRIBUTING.md](CONTRIBUTING.md) file.
308317

309318
<!-- Links to external references -->
310319
<!-- markdownlint-disable MD034 -->
320+
[1.3.1-release]: https://github.com/AxisCommunications/acap-runtime/releases/tag/1.3.1
311321
[acap-documentation]: https://axiscommunications.github.io/acap-documentation/docs/introduction/what-is-acap.html
312322
[acap-documentation-native]: https://axiscommunications.github.io/acap-documentation/docs/introduction/acap-sdk-overview.html#acap-native-sdk
313323
[acap-documentation-native-ml]: https://axiscommunications.github.io/acap-documentation/docs/api/native-sdk-api.html#machine-learning-api
@@ -320,6 +330,7 @@ Take a look at the [CONTRIBUTING.md](CONTRIBUTING.md) file.
320330
[dockerDesktop]: https://docs.docker.com/desktop/
321331
[dockerEngine]: https://docs.docker.com/engine/
322332
[gRPC]: https://grpc.io/
333+
[latest-release]: https://github.com/AxisCommunications/acap-runtime/releases/latest
323334
[minimal-ml-inference]: https://github.com/AxisCommunications/acap-computer-vision-sdk-examples/tree/main/minimal-ml-inference
324335
[openssl-req]: https://www.openssl.org/docs/man3.0/man1/openssl-req.html
325336
[object-detector-python]: https://github.com/AxisCommunications/acap-computer-vision-sdk-examples/tree/main/object-detector-python

0 commit comments

Comments
 (0)