From 64887314acfc099a3c981b90c4d5a904f847a90e Mon Sep 17 00:00:00 2001
From: Philip Wiese <wiesep@student.ethz.ch>
Date: Fri, 29 Nov 2024 00:57:45 +0100
Subject: [PATCH] Improve ReadMe

---
 .gitignore                      |  2 ++
 .vscode/c_cpp_properties.json   | 10 ++++++++++
 README.md                       | 25 ++++++++++++++++++-------
 tests/chimera-convolve/.gitkeep |  0
 tests/chimera-open/.gitkeep     |  0
 5 files changed, 30 insertions(+), 7 deletions(-)
 create mode 100644 .vscode/c_cpp_properties.json
 create mode 100644 tests/chimera-convolve/.gitkeep
 create mode 100644 tests/chimera-open/.gitkeep

diff --git a/.gitignore b/.gitignore
index 4ac4e47..9632188 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,5 @@
 *~
 .ninja*
 **/build/*
+
+.vscode/settings.json
diff --git a/.vscode/c_cpp_properties.json b/.vscode/c_cpp_properties.json
new file mode 100644
index 0000000..10c7365
--- /dev/null
+++ b/.vscode/c_cpp_properties.json
@@ -0,0 +1,10 @@
+{
+    "configurations": [
+        {
+            "name": "cMake",
+            "configurationProvider": "ms-vscode.cmake-tools",
+            "compileCommands": "${config:cmake.buildDirectory}/compile_commands.json"
+        }
+    ],
+    "version": 4
+}
\ No newline at end of file
diff --git a/README.md b/README.md
index 6d26e1b..79538e1 100644
--- a/README.md
+++ b/README.md
@@ -53,17 +53,28 @@ The resulting binaries will be stored in `build/bin`, and can be used within the
 
 To format all source files, run
 ```
-python scripts/run_clang_format.py -ir hal/
-python scripts/run_clang_format.py -ir targets/
-python scripts/run_clang_format.py -ir tests/
+python scripts/run_clang_format.py -ir hal/ targets/ tests/ driver/
 ```
 
 Our CI uses llvm-12 for clang-format, so on IIS machines you may run
 ```
-python scripts/run_clang_format.py -ir hal/ --clang-format-executable=/usr/pack/riscv-1.0-kgf/pulp-llvm-0.12.0/bin/clang-format
+python scripts/run_clang_format.py -ir tests/ hal/ targets/ driver/ --clang-format-executable=/usr/pack/riscv-1.0-kgf/pulp-llvm-0.12.0/bin/clang-format
 
-python scripts/run_clang_format.py -ir targets/ --clang-format-executable=/usr/pack/riscv-1.0-kgf/pulp-llvm-0.12.0/bin/clang-format
-
-python scripts/run_clang_format.py -ir tests/ --clang-format-executable=/usr/pack/riscv-1.0-kgf/pulp-llvm-0.12.0/bin/clang-format
+```
 
+## Visual Studio Code Integration
+
+To enable automatic configuration of the C/C++ extension and support for the integrated cMake build flow on the IIS workstations, add the following content to `.vscode/settings.json`:
+```json
+{
+    "cmake.configureSettings": {
+        "TOOLCHAIN_DIR": "/usr/pack/riscv-1.0-kgf/pulp-llvm-0.12.0/bin",
+        "TARGET_PLATFORM": "chimera-convolve",
+    },
+    "cmake.environment": {
+        "PATH": "/usr/pack/riscv-1.0-kgf/default/bin:${env:PATH}",
+        "LD_LIBRARY_PATH": "/usr/pack/riscv-1.0-kgf/lib64:/usr/pack/riscv-1.0-kgf/lib64",
+    }
+}
 ```
+
diff --git a/tests/chimera-convolve/.gitkeep b/tests/chimera-convolve/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/tests/chimera-open/.gitkeep b/tests/chimera-open/.gitkeep
new file mode 100644
index 0000000..e69de29