From e59aeac989b4886d0bab78f5e4f09329babaaa42 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Franti=C5=A1ek=20Boh=C3=A1=C4=8Dek?= Date: Sat, 10 Jul 2021 19:38:51 +0200 Subject: [PATCH] docs: add README to specify project purpose --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a80a6b0 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +* GHDL + Xilinx project template using makefiles + +* Root +Source is supposed to be located in `src/` and testbenches in `testbench/`. +Makefile supports compiling using ghdl, starting the program for specified +time and viewing the result in wave viewer. + +** Xil folder +In `xil` folder, makefile for Xilinx _toolchain_ can be found. +It supports everything from synthesis to uploading bit file +to the device. + +* Setup +For setup, top level entity has to be set in root `Makefile`. + +For xil setup, no special need is except from installing dependencies. + +* Dependencies +- root + - ghdl + - gtkview +- xil + - xflow (for synthesis, implementation and config) + - impact (for flashing on device) + -- 2.48.1