From f21493dc46f6f98907a8a831c7a152747cdc0b04 Mon Sep 17 00:00:00 2001 From: Michael Platings Date: Mon, 29 Apr 2024 15:22:04 +0000 Subject: [PATCH] Document platform support --- README.md | 1 + doc/platform-support.md | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 doc/platform-support.md diff --git a/README.md b/README.md index 61bd684a9..7c620317b 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ It is designed to be simple to integrate into a wide variety of projects. ## Documentation +* [Platform Support](doc/platform-support.md) * [Building](doc/build.md) * [OpenCV Hardware Adapter Layer](doc/opencv.md) * [Overview of KleidiCV functionality](doc/functionality.md) diff --git a/doc/platform-support.md b/doc/platform-support.md new file mode 100644 index 000000000..8f5e34465 --- /dev/null +++ b/doc/platform-support.md @@ -0,0 +1,32 @@ + + +# Platform Support + +Support for different platforms is organised in 3 tiers[^1]. + +## Tier 1 + +A released version of KleidiCV shall be tested for correctness and performance on a Tier 1 platform. + +At present the only Tier 1 platform is Android on Samsung Galaxy S22 or Google Pixel 8 with an up-to-date operating system. +Applications must be built with Android NDK r26d or later. + +## Tier 2 + +KleidiCV is tested for correctness on a Tier 2 platform, however performance is not checked. + +At present the only Tier 2 platform is AArch64 Ubuntu, as defined by `docker/Dockerfile` in the KleidiCV source tree. + +## Tier 3 + +KleidiCV aims to support Tier 3 platforms but since no routine +testing is done on these platforms it may or may not work in practise. + +At present the only Tier 3 platform is Mac computers with Apple silicon. + + +[^1] Inspired by [Rust's platform support](https://doc.rust-lang.org/nightly/rustc/platform-support.html). -- GitLab