Skip to content

Commit

Permalink
README: Add disclaimer on not being active track
Browse files Browse the repository at this point in the history
  • Loading branch information
pataxis committed Apr 3, 2024
1 parent 27ae882 commit febdc6a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
4 changes: 3 additions & 1 deletion .github/workflows/linter-documentation-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,9 @@ jobs:
for doc_url in $search_urls
do
found_doc_url=$(grep -nir "$doc_url" --exclude $workflowfile | grep -v $acap3_base_url)
[ -z "$found_doc_url" ] || {
# Whitelist link in disclaimer notice
found_doc_url_stripped=$(echo $found_doc_url |sed '/README.md:10/d')
[ -z "$found_doc_url_stripped" ] || {
printf "\nERROR: $doc_url is an ACAP $incorrect_sdk_version documentation URL found in:\n$found_doc_url\n"
found_error=y
}
Expand Down
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
> [!IMPORTANT]
>
> This repository has examples for ACAP version 3 SDK, which is not the latest
> version and might therefore not get updates, bug fixes or answers on tickets
> as frequently.
>
> It's recommended to move to ACAP version 4 SDK which is the active track:
>
> - [ACAP Native SDK example](https://github.com/AxisCommunications/acap-native-sdk-examples)
> - [ACAP Documentation](https://axiscommunications.github.io/acap-documentation)
# What is AXIS Camera Application Platform?

[AXIS Camera Application Platform (ACAP)](https://www.axis.com/support/developer-support/axis-camera-application-platform) is an open application platform that enables members of [Axis Application Development Partner](https://www.axis.com/partners/adp-partner-program) (ADP) Program to develop applications that can be downloaded and installed on Axis network cameras and video encoders. ACAP makes it possible to develop applications for a wide range of use cases:
Expand Down

0 comments on commit febdc6a

Please sign in to comment.