NutShell 项目使用教程

NutShell 项目使用教程

NutShell RISC-V SoC designed by students in UCAS 项目地址: https://gitcode.com/gh_mirrors/nu/NutShell

1. 项目目录结构及介绍

NutShell 项目的目录结构如下：

NutShell/
├── fpga/
│   ├── board/
│   ├── boot/
│   ├── lib/
│   ├── Makefile
│   ├── Makefile.check
│   └── NutShell.tcl
├── src/
├── tools/
├── .gitignore
├── .gitmodules
├── mill-version
├── LICENSE
├── Makefile
├── README.md
├── build.sc
├── debian_on_fpga.gif
├── env.sh
├── scalastyle-config.xml
└── scalastyle-test-config.xml

目录介绍：

• fpga/: 包含与 FPGA 相关的文件，如支持的 FPGA 板卡、启动流程、共享的 HDL 源文件等。
• src/: 包含项目的源代码。
• tools/: 包含项目使用的工具。
• .gitignore: Git 忽略文件列表。
• .gitmodules: Git 子模块配置文件。
• mill-version: Mill 构建工具的版本文件。
• LICENSE: 项目许可证文件。
• Makefile: 项目的 Makefile 文件，用于编译和构建项目。
• README.md: 项目的 README 文件，包含项目的基本介绍和使用说明。
• build.sc: Mill 构建脚本。
• debian_on_fpga.gif: 在 FPGA 上运行 Debian 的演示 GIF。
• env.sh: 环境配置脚本。
• scalastyle-config.xml: Scala 代码风格配置文件。
• scalastyle-test-config.xml: Scala 测试代码风格配置文件。

2. 项目启动文件介绍

NutShell 项目的启动文件主要包括以下几个部分：

2.1 Makefile

Makefile 是项目的主要构建文件，包含了编译、仿真、FPGA 部署等任务的指令。通过运行 make 命令，可以执行不同的任务。

2.2 env.sh

env.sh 是一个环境配置脚本，用于设置项目所需的环境变量。在运行项目之前，通常需要先执行该脚本以确保环境配置正确。

2.3 README.md

README.md 是项目的说明文档，包含了项目的基本介绍、使用方法、编译步骤等信息。启动项目前，建议先阅读该文件以了解项目的基本情况。

3. 项目配置文件介绍

NutShell 项目的配置文件主要包括以下几个部分：

3.1 scalastyle-config.xml 和 scalastyle-test-config.xml

这两个文件是 Scala 代码风格配置文件，用于定义代码的编写规范。通过这些配置文件，可以确保项目代码的一致性和可读性。

3.2 .gitignore

.gitignore 文件用于指定 Git 版本控制系统中需要忽略的文件和目录。通过该文件，可以避免将不必要的文件提交到代码仓库中。

3.3 .gitmodules

.gitmodules 文件用于管理 Git 子模块。通过该文件，可以方便地管理项目中使用的第三方库或子项目。

3.4 mill-version

mill-version 文件用于指定 Mill 构建工具的版本。通过该文件，可以确保项目在不同环境中使用相同版本的构建工具。

3.5 Makefile

Makefile 文件中包含了项目的各种配置选项，如编译选项、仿真选项、FPGA 部署选项等。通过修改该文件中的配置，可以定制项目的构建和运行方式。

通过以上介绍，您应该对 NutShell 项目的目录结构、启动文件和配置文件有了基本的了解。希望这些信息能够帮助您更好地使用和开发该项目。

NutShell RISC-V SoC designed by students in UCAS 项目地址: https://gitcode.com/gh_mirrors/nu/NutShell