From ef8bbbf69be57990c1e5bf69ba439c0d50328a16 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niccol=C3=B2=20Betto?= <niccolo.betto@skywarder.eu> Date: Thu, 5 Dec 2024 14:56:43 +0100 Subject: [PATCH] [Readme] Specify linting and formatting tool version requirements --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9ccf881ae..97fe212c0 100644 --- a/README.md +++ b/README.md @@ -29,11 +29,17 @@ The project is built with the CMake build system. We also have our own script th ### Dependencies +The following are required to build the project: * `CMake` 3.25 * `Git` * `Miosix` Toolchain -We also recommend to install `Ccache`, `Ninja`, `OpenOCD`, `Cppcheck`,`ClangFormat` and `pre-commit` for a smoother development experience. +You will also need the following tools for linting and formatting: +* `Python3` +* `Cppcheck 2.7` +* `ClangFormat 18` + +We also recommend to install `Ccache`, `Ninja`, `OpenOCD`, and `pre-commit` for a smoother development experience. ### Cloning the repo -- GitLab