FlintyLemming/PLFM_RADAR
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document repository file placement policy for generated artifacts

Browse Source
This commit is contained in:
Jason
2026-03-18 22:08:57 +02:00
parent bb7a7390c3
commit 981bd271fa
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+15
View File
@@ -128,6 +128,21 @@ The AERIS-10 main sub-systems are:
## 🚀 Getting Started ## 🚀 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 ### Prerequisites
- Basic understanding of radar principles - Basic understanding of radar principles