Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
programmable-logic:documents:git [2021/05/14 23:07] – ↷ Links adapted because of a move operation Arthur Brownprogrammable-logic:documents:git [2023/08/24 20:38] (current) – [Vitis (SW) Workspaces] Arthur Brown
Line 1: Line 1:
 ====== Digilent FPGA Demo Git Repositories ====== ====== Digilent FPGA Demo Git Repositories ======
- 
-<WRAP round todo> 
-== Under Construction == 
-This document is under construction. 
-</WRAP> 
  
 This document describes the git workflow for repositories on Digilent's Github containing demo projects for FPGA boards, and includes both structural descriptions of these repositories, as well as instructions on using these demo projects with git, and on loading and rebuilding these projects within the appropriate tools. This document describes the git workflow for repositories on Digilent's Github containing demo projects for FPGA boards, and includes both structural descriptions of these repositories, as well as instructions on using these demo projects with git, and on loading and rebuilding these projects within the appropriate tools.
Line 125: Line 120:
 The "hw" folder of the cloned root repository contains the sources of the Vivado project used to build the hardware design for the demo. The "hw" folder of the cloned root repository contains the sources of the Vivado project used to build the hardware design for the demo.
  
-**Important!** //Digilent's Vivado projects require a Vivado install with the board files for Digilent boards. If either of these requirements is not met, first run through the [[programmable-logic:guides:installation]] guide.//+**Important!** //Digilent's Vivado projects require a Vivado install with the board files for Digilent boards. If either of these requirements is not met, first run through the [[programmable-logic:guides:installing-vivado-and-vitis]] guide.//
  
 The Vivado project must be recreated from its source before use. To create the project, first launch the supported version of Vivado[(Demos only support one version of Vivado, as noted by version tags. For example, a commit with a tag matching "*-v2019.1-*" is only supported in Vivado 2019.1. Untagged commits may not contain fully functional demos.)]. Open Vivado's TCL console, and enter the command below. This will recreate and open the Vivado project. The Vivado project must be recreated from its source before use. To create the project, first launch the supported version of Vivado[(Demos only support one version of Vivado, as noted by version tags. For example, a commit with a tag matching "*-v2019.1-*" is only supported in Vivado 2019.1. Untagged commits may not contain fully functional demos.)]. Open Vivado's TCL console, and enter the command below. This will recreate and open the Vivado project.
Line 146: Line 141:
 ==== Petalinux (OS) Projects ==== ==== Petalinux (OS) Projects ====
  
-**Important!** //Digilent's Petalinux projects require a compatible Petalinux install. If this requirement is not met, see Chapter 2 of [[https://www.xilinx.com/support/documentation/sw_manuals/xilinx2020_1/ug1144-petalinux-tools-reference-guide.pdf|Xilinx Petalinux 2020.1 Reference Guide (UG1144)]] for more information on how to install Petalinux. Older versions of this document can be found on Xilinx's website.//+**Important!** //Digilent's Petalinux projects require a compatible Petalinux install. If this requirement is not met, see Chapter 2 of [[https://docs.xilinx.com/v/u/2020.1-English/ug1144-petalinux-tools-reference-guide|Xilinx Petalinux 2020.1 Reference Guide (UG1144)]] for more information on how to install Petalinux. Older versions of this document can be found on Xilinx's website.//
  
 **Important!** //Many demos containing a software component do not require Petalinux. If you are using one of these, skip ahead to [[#vitis_sw_workspaces|Vitis (SW) Workspaces]].// **Important!** //Many demos containing a software component do not require Petalinux. If you are using one of these, skip ahead to [[#vitis_sw_workspaces|Vitis (SW) Workspaces]].//
Line 164: Line 159:
 ==== Vitis (SW) Workspaces ==== ==== Vitis (SW) Workspaces ====
  
-**Important!** //Digilent's Vitis workspaces require a compatible Vitis install. If this requirement is not met, first run through the [[programmable-logic:guides:installation]] guide.//+**Important!** //Digilent's Vitis workspaces require a compatible Vitis install. If this requirement is not met, first run through the [[programmable-logic:guides:installing-vivado-and-vitis]] guide.//
  
 The Vitis workspace must be recreated from its source before use. To populate workspace, first launch the supported version of Vitis[(Demos only support one version of Vitis, as noted by version tags. For example, a commit with a tag ending in ''/2020.1'' is only supported in Vitis 2020.1. Untagged commits may not contain fully functional demos.)]. Use of the local repository's ''sw/ws'' folder for the Vitis workspace is recommended, and should be selected as Vitis launches. The Vitis workspace must be recreated from its source before use. To populate workspace, first launch the supported version of Vitis[(Demos only support one version of Vitis, as noted by version tags. For example, a commit with a tag ending in ''/2020.1'' is only supported in Vitis 2020.1. Untagged commits may not contain fully functional demos.)]. Use of the local repository's ''sw/ws'' folder for the Vitis workspace is recommended, and should be selected as Vitis launches.
Line 193: Line 188:
  
 <WRAP round todo> <WRAP round todo>
-Use of a released sysroot archive is not documented here. It will be added as Eclypse Z7 projects are updated.+Use of a released sysroot archive is not documented here.
 </WRAP> </WRAP>
 ~~REFNOTES~~ ~~REFNOTES~~
 ---- ----