From da99ebc62e7ae883f9847264457de70788334c07 Mon Sep 17 00:00:00 2001
From: Joseph Mead <mead@bnl.gov>
Date: Thu, 31 Oct 2024 11:46:17 -0400
Subject: [PATCH] first commit

---
 .gitmodules |  3 +++
 README.md   | 26 ++++++++++++++++++++++++++
 fwk         |  1 +
 3 files changed, 30 insertions(+)
 create mode 100644 .gitmodules
 create mode 100644 README.md
 create mode 160000 fwk

diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 0000000..5db4dfc
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "fwk"]
+	path = fwk
+	url = https://gitlab.desy.de/fpgafw/fwk.git
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..69eef84
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+zuBPM Hardware Platform 
+
+This is a custom designed hardware platform for the next gen rfBPM electroncs from the NSLS2 Diagnostics Group Using the Xilinx UltraScale+ technology.
+
+Uses the DESY FWK FPGA Firmware Framework https://fpgafw.pages.desy.de/docs-pub/fwk/index.html
+
+Clone with --recurse-submodules to get the FWK repos
+
+git clone --recurse-submodules https://github.com/NSLS-II/rfsoc-dfe
+
+Setup Environment: make env (first time only)
+
+To build firmware make cfg=hw project (Sets up project)
+
+make cfg=hw gui (Open in Vivado)
+
+make cfg=hw build (Builds bit file)
+
+To build Software
+
+make cfg=sw project (Sets up project)
+
+make cfg=sw gui (Opens in Vitis)
+
+make cfg=sw build (Builds executable)
+
diff --git a/fwk b/fwk
new file mode 160000
index 0000000..e78b406
--- /dev/null
+++ b/fwk
@@ -0,0 +1 @@
+Subproject commit e78b406f3261bdb0969a58f592504b3b4449d95e