Browse Source

fix: update create new project section

master
Dennis Buchhorn 2 years ago
parent
commit
3e598591ef
2 changed files with 18 additions and 12 deletions
  1. +14
    -10
      README.md
  2. +4
    -2
      README_PROJECT_TEMPLATE.md

+ 14
- 10
README.md View File

@ -22,25 +22,29 @@ Vitis is a little bit less pain in the ass than Vivado to version control decent
#### Create new project #### Create new project
1. When first starting a project, create the workspace in a new folder.
1. Use this repository as template and take the `Git Content`.
2. Copy the hardware specification file (.xsa) into the workspace folder.
2. Clone the new created repository - This folder will be the workspace folder.
3. Create a new platform project called `hw_platform` and choose the copied hardware specification file.
3. Execute the following command in the workspace folder:
4. Create a new application project via `File -> New -> Application Project...`, choose the platform created befor and name the application project as you want.
- `git config --local core.hooksPath .githooks` - set path to git-hooks for this repository.
5. Copy the `.gitignore` file and the `.githooks` folder from this repository into the workspace folder.
4. Copy the hardware specification file (.xsa) into the workspace folder.
6. Execute the following commands in the workspace folder:
5. Open Vitis and select the cloned folder as workspace - `vitis -workspace .`.
- `git init` - initialize git repository in the workspace folder.
6. Create a new platform project called `hw_platform` and choose the copied hardware specification file.
- `git config --local core.hooksPath .githooks` - set path to git-hooks for this repository.
7. Build the platform project.
8. Create a new application project via `File -> New -> Application Project...`, choose the platform created befor and name the application project as you want.
9. Execute the following commands in the workspace folder:
- `git add .` - add all relevant files to the repository.
- `git add .` - add all relevant files to the repository - Files that are not relevant are ignored by the `.gitignore` file.
- `git commit -m 'initial commit'` - create initial commit.
- `git commit -m 'create project'` - create project commit.
#### Clone existing project #### Clone existing project


+ 4
- 2
README_PROJECT_TEMPLATE.md View File

@ -1,6 +1,6 @@
# ${REPO_NAME} # ${REPO_NAME}
Created with Vitis Version 2020.2
Use preferably with Vitis Version 2020.2
Created from Template [`${TEMPLATE_NAME}`](${TEMPLATE_LINK}) Created from Template [`${TEMPLATE_NAME}`](${TEMPLATE_LINK})
@ -26,7 +26,9 @@ Created from Template [`${TEMPLATE_NAME}`](${TEMPLATE_LINK})
### Workflow ### Workflow
- When you want to commit your work, add all files with `git add .` - Not relevant files will be ignored by the `.gitignore` file.
- When you want to commit your work, add all files with `git add .` - Files that are not relevant are ignored by the `.gitignore` file.
- During the commit, the `pre-commit` hook script is executed and changes the local-absolute paths to relative paths.
#### Checkout branch #### Checkout branch


Loading…
Cancel
Save