From e60bebf7f6e6c808c50adf59e2ee7ae4bf1826c1 Mon Sep 17 00:00:00 2001 From: James Talbert <jtalbert@iastate.edu> Date: Mon, 24 Sep 2018 17:56:58 -0500 Subject: [PATCH] Update creating-maintaining-new-project.md --- quad/doc/creating-maintaining-new-project.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/quad/doc/creating-maintaining-new-project.md b/quad/doc/creating-maintaining-new-project.md index 4e011299d..129a51cc9 100644 --- a/quad/doc/creating-maintaining-new-project.md +++ b/quad/doc/creating-maintaining-new-project.md @@ -30,3 +30,18 @@ and adding the following at the end of the file: make_wrapper -files [get_files ${origin_dir}/${_xil_proj_name_}/${_xil_proj_name_}.srcs/sources_1/bd/design_1/design_1.bd] -top add_files -norecurse ${origin_dir}/${_xil_proj_name_}/${_xil_proj_name_}.srcs/sources_1/bd/design_1/hdl/design_1_wrapper.vhd ``` + +# Version Control +At the top of the tcl file for the project, there is a list of files that need to be in version control. +All of these should be added to the repo, as well as the tcl script itself, but not the `design_1_wrapper.vhd` file. +No other files for this project need be added to the repo. Any time you add a source file, please add it under src, not the auto-generated folder. +If you add it to the auto-generated folder, the scriopt will not be able to build the project as it will delete the file before building and then be unable to find it. + +## I made a mistake and added a new file to the default folder +1. Don't do that again please +2. We can fix it: + +1. Go in to the folder structure and copy the file from the bad place (see file properties in Vivado) to `<project>/src/...` +2. Go into Vivado and delete the old file from the project +3. In Vivado, add the new file to the project +4. Update git to revision the new file. \ No newline at end of file -- GitLab