Update README

2023-03-20 23:56:12 +08:00
parent 71065a374b
commit fd85ee5d5a
1 changed files with 100 additions and 1 deletions
@@ -8,6 +8,7 @@ This repository includes all the design sources and third-party reference used i
  - [Table of Contents](#table-of-contents)
  - [Background](#background)
  - [How this repository is constructed?](#how-this-repository-is-constructed)
+    - [Overview](#overview)
    - [Top Level](#top-level)
    - [Basic Vivado Project Structure](#basic-vivado-project-structure)
  - [Demos](#demos)
@@ -22,6 +23,104 @@ Since the day I joined my lab, managing Vivado projects has always been a pain i

 This repository is designed to store Vivado project design sources and Verilog/VHDL files primarily, but it can also hold associated MATLAB files and related documentation explaining how the modules work and things that need to be taken care of when interfacing with the modules.

+### Overview
+
+``` plain
+|
+│  .gitignore
+│  README.md
+│
+├─adi_library
+│  └─...
+│
+├─custom_ips
+├─modules
+│  └─xc7k410tffg900-2
+│      └─tx_qpsk
+│          ├─constraints
+│          ├─docs
+│          ├─ip
+│          │  │  hrc_64_12_025.xcix
+│          │  │
+│          │  ├─coe
+│          │  │      hrc_64_12_025.coe
+│          │  │
+│          │  └─managed_ip_project
+│          │      │  managed_ip_project.xpr
+│          │      │
+│          │      └─managed_ip_project.cache
+│          │         └─...
+│          │
+│          ├─ipi-bds
+│          ├─project
+│          │  └─tx_qpsk
+│          │          tx_qpsk.tcl
+│          │
+│          ├─rtl
+│          │      tx_qpsk.v
+│          │
+│          ├─scripts
+│          └─testbenches
+│                  tb_tx_qpsk.v
+│
+├─projects
+│  └─datalink_814
+│      └─dl814_k7
+│          ├─constraints
+│          │      k7410t_ad9516_2ad9361_physical.xdc
+│          │
+│          ├─docs
+│          ├─ip
+│          │  │  sys_clk_gen.xcix
+│          │  │
+│          │  └─managed_ip_project
+│          │     └─...
+│          │
+│          ├─ipi-bds
+│          │  └─system_bd
+│          │      │  system_bd.bd
+│          │      │
+│          │      └─hdl
+│          │             system_bd_wrapper.v
+│          │
+│          ├─project
+│          │  └─dl814_k7_cmos
+│          │      │  dl814_k7_cmos.tcl
+│          │      │
+│          │      ├─dl814_k7_cmos.hw
+│          │      │      dl814_k7_cmos.lpr
+│          │      │
+│          │      ├─dl814_k7_cmos.runs
+│          │      │  └─impl_1
+│          │      │          system_top.bit
+│          │      │
+│          │      └─dl814_k7_cmos.sdk
+│          │          │  system_top.hdf
+│          │          │
+│          │          ├─dl814_cmos_41M6
+│          │          │  └─src
+│          │          │      └─...
+│          │          │
+│          │          └─dl814_cmos_48M_bsp
+│          │                  system.mss
+│          │
+│          └─rtl
+│              │  system_top.v
+│              │
+│              └─...
+│
+└─template
+    ├─constraints
+    ├─docs
+    ├─ip
+    ├─ipi-bds
+    ├─project
+    ├─rtl
+    ├─scripts
+    └─testbenches
+
+```
+
 ### Top Level

 The organization of the top level structure is shown in the table below.
@@ -118,7 +217,7 @@ The table below outlines the git-friendly Vivado project structure. It is import

    Create new script used to recreate the Vivado project via **File -> Project -> Write Tcl** with all checkbox set as default, set `Output File` to be `./projects/<engProj>/<gitProj>/project/<vivadoProj>/<vivadoProj>.tcl`.

-11. (optional) Archive Project
+11. (Optional) Archive Project

    Archive the Vivado project into a compressed zip file via **File -> Archive**, change `Archive location` to anywhere except the git repository, because the archived project is currently not under revision control. The archive command copies all local or remote sources and run results, so the archive is self-contained.