开源项目 `hls_tutorial_examples` 使用教程

开源项目 hls_tutorial_examples 使用教程

hls_tutorial_examplesExamples shown as part of the tutorial "Productive parallel programming on FPGA with high-level synthesis".项目地址:https://gitcode.com/gh_mirrors/hl/hls_tutorial_examples

1. 项目的目录结构及介绍

hls_tutorial_examples 是一个用于高层次综合（HLS）教程的示例项目。项目的目录结构如下：

hls_tutorial_examples/
├── example_0
├── example_1
├── example_2
├── example_3
├── example_4
├── example_5
├── example_6
├── example_7
├── hlslib @ 086fc2b
├── .gitignore
├── .gitmodules
├── CMakeLists.txt
├── LICENSE
└── README.md

目录介绍

• example_0 至 example_7: 包含不同的高层次综合示例。
• hlslib @ 086fc2b: 作为子模块依赖的库。
• .gitignore: Git 忽略文件。
• .gitmodules: Git 子模块配置文件。
• CMakeLists.txt: CMake 配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。

2. 项目的启动文件介绍

项目的启动文件主要是 CMakeLists.txt，它负责配置和构建项目。以下是 CMakeLists.txt 的主要内容：

# CMakeLists.txt
cmake_minimum_required(VERSION 3.5)
project(hls_tutorial_examples)

# 添加子模块
add_subdirectory(hlslib)

# 配置示例
foreach(example IN ITEMS example_0 example_1 example_2 example_3 example_4 example_5 example_6 example_7)
    add_subdirectory(${example})
endforeach()

启动文件介绍

• cmake_minimum_required(VERSION 3.5): 指定所需的最低 CMake 版本。
• project(hls_tutorial_examples): 定义项目名称。
• add_subdirectory(hlslib): 添加 hlslib 子模块。
• foreach(example IN ITEMS example_0 example_1 example_2 example_3 example_4 example_5 example_6 example_7): 循环添加各个示例子目录。

3. 项目的配置文件介绍

项目的配置文件主要是 CMakeLists.txt 和 .gitmodules。

CMakeLists.txt

如上所述，CMakeLists.txt 负责配置和构建项目。它通过添加子模块和配置示例子目录来确保项目正确构建。

.gitmodules

.gitmodules 文件定义了项目的子模块依赖关系。以下是 .gitmodules 的内容：

[submodule "hlslib"]
    path = hlslib
    url = https://github.com/spcl/hlslib.git

配置文件介绍

• .gitmodules: 定义了 hlslib 子模块的路径和 URL。

通过以上配置文件，项目可以正确地管理依赖关系并进行构建。

---

以上是 hls_tutorial_examples 项目的基本使用教程，包括项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。

hls_tutorial_examplesExamples shown as part of the tutorial "Productive parallel programming on FPGA with high-level synthesis".项目地址:https://gitcode.com/gh_mirrors/hl/hls_tutorial_examples