From 981bd271fa540f56ad9c0d3cff6a7c1e74dcac8b Mon Sep 17 00:00:00 2001
From: Jason <83615043+JJassonn69@users.noreply.github.com>
Date: Wed, 18 Mar 2026 22:08:57 +0200
Subject: [PATCH] Document repository file placement policy for generated
 artifacts

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index 2510488..7dba2fc 100644
--- a/README.md
+++ b/README.md
@@ -128,6 +128,21 @@ The AERIS-10 main sub-systems are:
 
 ## 🚀 Getting Started
 
+## 🧹 Repository File Placement Policy
+
+To keep the repository root clean and make artifacts easy to find, place generated files in the following locations:
+
+- **Published reports (tracked, GitHub Pages):** `docs/`
+  - Example: `docs/AERIS_Simulation_Report_v2.pdf`
+- **Simulation-generated outputs (local, gitignored):** `5_Simulations/generated/`
+  - Plots, scenario outputs, temporary analysis directories
+- **FPGA/Vivado generated artifacts (local, gitignored):** `9_Firmware/9_2_FPGA/reports/`
+  - VCD/VVP dumps, temporary CSVs, local report snapshots
+- **Reusable FPGA automation scripts (tracked):** `9_Firmware/9_2_FPGA/scripts/`
+  - TCL flows, helper scripts used by build/bring-up
+
+Do not leave generated artifacts in the repository root.
+
 ### Prerequisites
 
 - Basic understanding of radar principles