From 607f8c2928b9ed4567098607d6e1ad7044fd3d60 Mon Sep 17 00:00:00 2001 From: Joakim Roubert Date: Fri, 1 Nov 2024 13:39:47 +0100 Subject: [PATCH] Minor housekeeping - Use ARG instead of ENV for apt setting in Dockerfile - Make README.md somewhat clearer Change-Id: I98c11bb377f3d6a0b3e79149147408f495e47944 Signed-off-by: Joakim Roubert --- Dockerfile | 2 +- README.md | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Dockerfile b/Dockerfile index 7089253..d111d03 100644 --- a/Dockerfile +++ b/Dockerfile @@ -10,7 +10,7 @@ FROM $SDK_IMAGE:$ACAP_SDK_VERSION-$ARCH AS builder ARG ACAP_BUILD_DIR ARG LIBMODBUS_BUILD_DIR ARG LIBMODBUS_VERSION -ENV DEBIAN_FRONTEND=noninteractive +ARG DEBIAN_FRONTEND=noninteractive # Install additional build dependencies # hadolint ignore=DL3008 diff --git a/README.md b/README.md index eb778d8..c0df714 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,17 @@ # Modbus ACAP -[![Build ACAPs](https://github.com/AxisCommunications/modbus-acap/actions/workflows/build.yml/badge.svg)](https://github.com/AxisCommunications/modbus-acap/actions/workflows/build.yml) +[![Build ACAP packages](https://github.com/AxisCommunications/modbus-acap/actions/workflows/build.yml/badge.svg)](https://github.com/AxisCommunications/modbus-acap/actions/workflows/build.yml) [![GitHub Super-Linter](https://github.com/AxisCommunications/modbus-acap/actions/workflows/super-linter.yml/badge.svg)](https://github.com/AxisCommunications/modbus-acap/actions/workflows/super-linter.yml) -This repository contains the source code to build a small prototype +**This repository contains the source code to build a small prototype [ACAP version 4](https://axiscommunications.github.io/acap-documentation/) (native) application that exports events from [AXIS Object Analytics](https://www.axis.com/products/axis-object-analytics) (AOA) over [Modbus](https://en.wikipedia.org/wiki/Modbus) using -[libmodbus](https://libmodbus.org/). The application can be run in either server -or client mode, meaning two Axis devices can be used to showcase it. +[libmodbus](https://libmodbus.org/).** The application can be run in either +server or client mode, meaning two Axis devices can be used to showcase it. ![Architectural overview](images/acap_architecture.svg) @@ -29,7 +29,7 @@ then be deployed on the target Axis device e.g. via the device's web UI. deploy, please see the documentation on how to [Develop ACAP applications](https://axiscommunications.github.io/acap-documentation/docs/develop/).* -The build uses [Docker](https://www.docker.com/) and the containerized ACAP SDK. +*The build* uses [Docker](https://www.docker.com/) and the containerized ACAP SDK. If you have `make` on your computer the Docker commands are nicely wrapped in the [Makefile](Makefile). All you need to do then is: @@ -88,7 +88,7 @@ curl -k --anyauth -u root: \ To [start (or stop/restart/remove)](https://www.axis.com/vapix-library/subjects/t10102231/section/t10036126/display?section=t10036126-t10010606) -the ACAP, you can make a call like this: +the ACAP application, you can make a call like this: ```sh curl -k --anyauth -u root: \