|author||Raptor Engineering Development Team <email@example.com>||2019-04-29 12:14:53 -0500|
|committer||Raptor Engineering Development Team <firstname.lastname@example.org>||2019-04-29 12:14:53 -0500|
Add initial README.md file
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
@@ -0,0 +1,27 @@
+# Raptor System FPGA General Information
+This document contains general information applicable to most Raptor Computing Systems FPGA source trees. For specific information on a particular product, please consult the provided schematics and FPGA source HDL.
+The system FPGA sources are designed with, and are fully synthesizeable and routable with, the open-source Icestorm tooling. For more details on Icestorm please visit http://www.clifford.at/icestorm/
+We recommend using a Debian Buster installation with the non-free repositories disabled. As part of the build process runs timing-driven PAR, a multi-core system with at least 64 threads is useful to speed up the build process. We recommend building the FPGA image directly on a decently sized, blob free OpenPOWER system for maximum security and ease of development.
+At minimum, the following packages are required:
+apt-get install build-essential yosys fpga-icestorm
+If simulation capability is desired, also install:
+apt-get install iverilog gtkwave
+Building is simple. From within the source directory, execute:
+make -j <number of threads in build system> all
+When the build is complete, you will see a system_fpga.rom file. This is the complete image you need to program the Flash device for the FPGA in question on your Raptor Computing Systems product.