Add Sparse and build test information to README
To make it easier to build the driver stack, the README now specifies
the minimum required Sparse version needed and how the driver stack has
been build tested.
Change-Id: I1676ff8333da0f752badbf366229bf3d65ee4657
Signed-off-by: Mikael Olsson <mikael.olsson@arm.com>
diff --git a/README.md b/README.md
index e84c2f2..82be485 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,9 @@
# Building
The driver stack comes with a CMake based build system. A toolchain file is
-provided for reference how to cross compile for Aarch64 based systems.
+provided for reference how to cross compile for Aarch64 based systems. The
+driver stack build has been tested on the `Ubuntu 22.04 LTS x86 64-bit` Linux
+distribution.
Note that if your host system provides cross compilers and libraries of newer
versions than what is supported on your target system, you might be required to
@@ -21,9 +23,10 @@
show what it could look like. Another option is to run a Docker image of an
appropriate Linux distribution suited to build for your needs.
-Building the kernel modules requires a configured Linux kernel source tree.
-Please refer to the Linux kernel official documentation for instructions how to
-configure and build the Linux kernel.
+Building the kernel modules requires a configured Linux kernel source tree and
+a minimum Sparse version of 0.6.4. Please refer to the Linux kernel official
+documentation for instructions how to configure and build the Linux kernel and
+Sparse.
```
$ cmake -B build --toolchain $PWD/cmake/toolchain/aarch64-linux-gnu.cmake -DKDIR=<Kernel directory>