zzh/2025-yatcpu
1
0
Fork 0
mirror of https://github.com/handsomezhuzhu/2025-yatcpu.git synced 2026-02-20 20:10:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
TOKISAKIX\21168
2023-12-13 17:31:48 +08:00
parent d51ebe91a4
commit 379c44a60a
4 changed files with 16 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/docs/board.md
View File

@@ -1,3 +1,5 @@
Writen By: [Tokisakix](https://github.com/Tokisakix)
# 如何使用一键烧板脚本 # 如何使用一键烧板脚本
> 此烧板脚本对任意方式配置的开发环境都有效，因为 vivado 的烧板跟开发环境是**相互独立**的，如果你使用 Dev Container 或 WSL 配置环境，你需要回到 Windows 下打开 PowerShell 进行烧板。 > 此烧板脚本对任意方式配置的开发环境都有效，因为 vivado 的烧板跟开发环境是**相互独立**的，如果你使用 Dev Container 或 WSL 配置环境，你需要回到 Windows 下打开 PowerShell 进行烧板。
@@ -15,6 +17,8 @@
sbt "runMain board.z710.VerilogGenerator" sbt "runMain board.z710.VerilogGenerator"
``` ```
你也可以在配置好环境的 IDEA 中打开 src/main/scala/board/z710/Top.scala，点击 object VerilogGenerator extends App 一行左边的绿色三角形运行即可。
**生成比特流二进制文件** **生成比特流二进制文件**
执行下述指令，可以根据 verilog/z710/Top.v 生成二进制文件 vivado/z710/riscv-z710/riscv-z710.runs/impl_1/Top.bit。 执行下述指令，可以根据 verilog/z710/Top.v 生成二进制文件 vivado/z710/riscv-z710/riscv-z710.runs/impl_1/Top.bit。

8
docs/docs/env.md
View File

@@ -1,6 +1,8 @@
Writen By: [Tokisakix](https://github.com/Tokisakix)
# 如何使用 Vscode + Dev Container 来一键完成环境配置 # 如何使用 Vscode + Dev Container 来一键完成环境配置
> 如果你已经在你的设备上完成了开发的环境配置，可以跳过此内容。 > 如果你已经在你的设备上完成了开发的环境配置，可以选择跳过此内容。
> **此部分内容搬运自 [YatCPU 的 Dev Container 环境配置](http://tokisakix.cn/2023/11/14/%5BDocker%5D%20YatCPU%20%E7%9A%84%20Dev%20container%20%E7%8E%AF%E5%A2%83%E9%85%8D%E7%BD%AE/)**，你可以前往文档原地址获得更好的阅读体验 > **此部分内容搬运自 [YatCPU 的 Dev Container 环境配置](http://tokisakix.cn/2023/11/14/%5BDocker%5D%20YatCPU%20%E7%9A%84%20Dev%20container%20%E7%8E%AF%E5%A2%83%E9%85%8D%E7%BD%AE/)**，你可以前往文档原地址获得更好的阅读体验
使用 Docker + Dev Container 配置开发环境比较简单，而且也经过了测试，所以，我们推荐在 Windows 上直接使用 Dev Container 来设置开发环境。 使用 Docker + Dev Container 配置开发环境比较简单，而且也经过了测试，所以，我们推荐在 Windows 上直接使用 Dev Container 来设置开发环境。
@@ -21,7 +23,7 @@
**使用 Dev Containers 打开项目** **使用 Dev Containers 打开项目**
我们可以按 VSCode 左下角的蓝色按钮来运行 Dev Containers: 仓库内已经提前准备写好了启动 Dev Containers 的配置文件，所以我们无须自行编写配置文件，可以直接按 VSCode 左下角的蓝色按钮来运行 Dev Containers:
在上方的运行选项中选择在容器中重新打开，这个命令会让 Dev container 自动根据 <code>devcontainer.json</code> 里的配置信息来创建 Docker 环境 在上方的运行选项中选择在容器中重新打开，这个命令会让 Dev container 自动根据 <code>devcontainer.json</code> 里的配置信息来创建 Docker 环境
@@ -33,7 +35,7 @@
上述步骤完成后，我们就可以像在 Dev container 为我们配置好的开发环境中运行、调试代码了。 上述步骤完成后，我们就可以像在 Dev container 为我们配置好的开发环境中运行、调试代码了。
新建终端输入 <code>sbt test</code>，期望你有如下输出 切换路径为 <code>2023-fall-yatcpu-repo/mini-yatcpu/</code>，新建终端并输入 <code>sbt test</code>，期望你有如下输出
![image](asset/devcontainer3.png) ![image](asset/devcontainer3.png)

6
docs/docs/index.md
View File

@@ -1,3 +1,9 @@
Writen By: [Tokisakix](https://github.com/Tokisakix)
# 前言
YatCPU (Yet another toy CPU，逸芯) 是一款开源、开发中的教学用 RISC-V 处理器，基于 Chisel 硬件设计语言实现，并用于中山大学 (Sun Yat-sen University) 计算机学院冯班组成原理实验课程的教学。同样欢迎其他高校相关课程使用！
本仓库由 [Tokisakix](https://github.com/Tokisakix)、[PurplePower](https://github.com/PurplePower)、[Han Huang](https://github.com/HHTheBest) 在 [2022-fall-yatcpu-repo](https://github.com/hrpccs/2022-fall-yatcpu-repo) 的基础上结合 2023 计组教学实情整理而来，有较多原创内容 本仓库由 [Tokisakix](https://github.com/Tokisakix)、[PurplePower](https://github.com/PurplePower)、[Han Huang](https://github.com/HHTheBest) 在 [2022-fall-yatcpu-repo](https://github.com/hrpccs/2022-fall-yatcpu-repo) 的基础上结合 2023 计组教学实情整理而来，有较多原创内容
(PS: 能求个 star⭐ 吗 QAQ ~) (PS: 能求个 star⭐ 吗 QAQ ~)

2
docs/mkdocs.yml
View File

@@ -3,7 +3,7 @@ site_author: Tokisakix
copyright: Copyright © 2023 Tokisakix copyright: Copyright © 2023 Tokisakix
nav: nav:
- 主页: index.md - 前言: index.md
- 如何一键环境配置: env.md - 如何一键环境配置: env.md
- 如何一键烧板: board.md - 如何一键烧板: board.md