Refactor PulseWidthModulator entity parameters and update README for project setup
This commit is contained in:
34
README.md
34
README.md
@@ -33,18 +33,17 @@ The course focuses on:
|
||||
### Clone the Repository
|
||||
To get started with this project, follow these steps:
|
||||
|
||||
1. Open a terminal (e.g., Command Prompt or PowerShell) on your Windows machine.
|
||||
2. Navigate to the `C:\` directory:
|
||||
```cmd
|
||||
cd C:\
|
||||
```
|
||||
3. Clone the repository using Git:
|
||||
1. Open a terminal (e.g., Command Prompt or PowerShell) on your Windows machine.
|
||||
2. Clone the repository using Git:
|
||||
```cmd
|
||||
git clone https://git.cdtech.duckdns.org/PickleRick/DESD.git
|
||||
```
|
||||
This will create a folder named `DESD` in `C:\`.
|
||||
This will create a folder named `DESD`.
|
||||
3. Open the folder `\DESD` in [Visual Studio Code](https://code.visualstudio.com/).
|
||||
|
||||
4. Open the folder `C:\DESD` in [Visual Studio Code](https://code.visualstudio.com/).
|
||||
> ⚠️ **Warning**:
|
||||
> The folder structure in the repository may not match the Vivado project structure.
|
||||
> If you encounter issues with missing or mismatched files in Vivado, refer to the [Replacing Files in Vivado](#replacing-files-in-vivado) section to update the project with the correct files.
|
||||
|
||||
### Install VHDL Extension
|
||||
To work with VHDL files in Visual Studio Code, install the **VHDL LS** extension:
|
||||
@@ -55,5 +54,24 @@ To work with VHDL files in Visual Studio Code, install the **VHDL LS** extension
|
||||
4. Click **Install** on the extension by [Håkon Bohlin](https://marketplace.visualstudio.com/items?itemName=hbohlin.vhdl-ls).
|
||||
5. Restart Visual Studio Code to activate the extension.
|
||||
|
||||
### Open Projects in Vivado
|
||||
To open and work with the Vivado projects included in this repository:
|
||||
|
||||
1. Launch **Xilinx Vivado 2020.2**.
|
||||
2. Click on **Open Project** in the Vivado start screen.
|
||||
3. Navigate to the desired project directory (e.g., `LABx/vivado/project_folder/`) and select the `.xpr` file.
|
||||
4. Once the project is loaded, you can explore the design, run simulations, or synthesize the project.
|
||||
|
||||
#### Replacing Files in Vivado
|
||||
If the folder structure in the repository does not match the Vivado project structure:
|
||||
|
||||
1. Open the Vivado project as described above.
|
||||
2. In the **Sources** tab, right-click on the file you want to replace and select **Replace File**.
|
||||
3. Navigate to the correct file in the repository (e.g., `LABx/src/`) and select it.
|
||||
4. Ensure the file is added to the correct hierarchy (e.g., as a design source or constraint file).
|
||||
5. Save the project and re-run synthesis or simulation as needed.
|
||||
|
||||
By following these steps, you can ensure that the Vivado project is correctly configured and up-to-date with the repository files.
|
||||
|
||||
## 📬 Contact
|
||||
For any questions or issues open an issue in this repository.
|
||||
Reference in New Issue
Block a user