first commit

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "fwk"]
+	path = fwk
+	url = https://gitlab.desy.de/fpgafw/fwk.git

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)
+