From ca17ae90c4fe49e578d010671cebb699b3d8a550 Mon Sep 17 00:00:00 2001
From: Daniel Friesel <daniel.friesel@uos.de>
Date: Fri, 22 Oct 2021 16:16:22 +0200
Subject: start documenting env

---
 README.md | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 5529261..72ce2dd 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,4 @@
-Dependencies
----
-
-```
-sudo apt install python3-numpy python3-scipy python3-sklearn
-```
-
-Code Style
----
+## Code Style
 
 Please only commit blackened code. It's best to check this with a pre-commit
 hook:
@@ -27,3 +19,13 @@ exec 1>&2
 
 black --check $(git diff --cached --name-only --diff-filter=ACM $against | grep '\.py$')
 ```
+
+## Environment Variables
+
+The following variables may be set to alter the behaviour of dfatool components.
+
+| Flag  | Range | Description |
+| :--- | :---: | :--- |
+| `DFATOOL_KCONF_WITH_CHOICE_NODES` | 0, **1** | Treat kconfig choices (e.g. "choice Model → MobileNet / ResNet / Inception") as enum parameters. If enabled, the corresponding boolean kconfig variables (e.g. "Model\_MobileNet") are not converted to parameters. If disabled, all (and only) boolean kconfig variables are treated as parameters. Mostly relevant for analyze-kconfig, eval-kconfig |
+| `DFATOOL_COMPENSATE_DRIFT` | **0**, 1 | Perform drift compensation for loaders without sync input (e.g. EnergyTrace or Keysight) |
+| `DFATOOL_DRIFT_COMPENSATION_PENALTY` | 0 .. 100 (default: majority vote over several penalties) | Specify penalty for ruptures.py PELT changepoint petection |
-- 
cgit v1.2.3