From a67c6500b1a06b4864eda2ad6f0856a1af9abd92 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gr=C3=A9goire=20KUBLER?= <gregoire.kubler@proton.me>
Date: Mon, 8 Jul 2024 16:29:24 +0200
Subject: [PATCH] feat: upd readme

---
 README.md | 32 ++++++++++++++++++++------------
 1 file changed, 20 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 682f507..312ac11 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,30 @@
-# Aidge CPU library
+# Aidge backend OpenCV library
 
 You can find in this folder the library that implements :
 - Computer vision databases 
 - The OpenCV tensor, operators and stimulis
 
 So far be sure to have the correct requirements to use this library
-- GCC
-- OpenCV >= 3.0
-- Make
-- CMake
-- aidge_core
-- aidge_backend_cpu
-- Python (optional, if you have no intend to use this library in python with pybind)
+[TOC]
 
-## Pip installation
+## Installation
+### Dependencies
+- `GCC`
+- `OpenCV` >= 3.0
+- `Make`
+- `CMake`
+- `Python` (optional, if you have no intend to use this library in python with pybind)
 
-You will need to install first the aidge_core and aidge_backend_cpu libraries before installing aidge_backend_opencv.
-Then run in your python environnement : 
+#### aidge dependencies
+ - `aidge_core`
+ - `aidge_backend_cpu`.
+
+### Pip installation
 ``` bash
 pip install . -v
-```
\ No newline at end of file
+```
+> **TIPS :** Use environment variables to change compilation options :
+> - `AIDGE_INSTALL` : to set the installation folder. Defaults to /usr/local/lib. :warning: This path must be identical to aidge_core install path.
+> - `AIDGE_PYTHON_BUILD_TYPE` : to set the compilation mode to **Debug** or **Release** 
+> - `AIDGE_BUILD_GEN` : to set the build backend with 
+
-- 
GitLab