From 892abc6461e47ec8f73d6f21301014c0a42dd7ec Mon Sep 17 00:00:00 2001 From: Erwan Velu Date: Thu, 23 May 2024 15:38:23 +0200 Subject: [PATCH] README: Explicit the main requirements When people discover the project, it's cool to give a quick overview of what are the dependencies to make this project being used. Signed-off-by: Erwan Velu --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index df9dda4..52ea2a2 100644 --- a/README.md +++ b/README.md @@ -55,3 +55,19 @@ If a single output file is provided, **hwgraph** plots for each benchmark : If multiple output files are passed as arguments, and only if they were generated with the same script file, **hwgraph** will compare for each benchmark the performance metrics. For more details, see the specific documentation. + +# Requirements +## Mandatory +- python >= 3.9 +- [python dependencies](./requirements/base.in) +- turbostat >= 2022.07.28 +- numactl +- dmidecode +- util-linux >= 2.32 +- lspci +- rpm + +## Optional +- ipmitool +- ilorest (for HPE servers) +- stress-ng >= 0.17.04 \ No newline at end of file