From 3f918f0d7811ccc83095a3bf792422cb1ea1b8a1 Mon Sep 17 00:00:00 2001
From: "TOKISAKIX\\21168" <2116884726@qq.com>
Date: Wed, 13 Dec 2023 09:59:30 +0800
Subject: [PATCH] update docs
---
docs/board.md | 9 +++------
docs/env_doc.md | 6 +++---
2 files changed, 6 insertions(+), 9 deletions(-)
diff --git a/docs/board.md b/docs/board.md
index 878dd54..aa0c256 100644
--- a/docs/board.md
+++ b/docs/board.md
@@ -7,19 +7,16 @@
**生成 Verilog 文件**
+下面的教程以 ZYBO-Z710 开发板为例，其他开发板可以根据开发板名称自行替换。
+
根据开发板型号，在命令行输入对应型号的运行指令，运行相应目录的 Top.scala 文件，生成的结果位于 verilog/开发板名称 目录下的 Top.v，下方是参考的代码：
```
-sbt "runMain board.basys3.VerilogGenerator"
-sbt "runMain board.verilator.VerilogGenerator"
-sbt "runMain board.pynq.VerilogGenerator"
sbt "runMain board.z710.VerilogGenerator"
```
**生成比特流二进制文件**
-下面的教程以 ZYBO-Z710 开发板为例，其他开发板可以根据开发板名称自行替换。
-
执行下述指令，可以根据 verilog/z710/Top.v 生成二进制文件 vivado/z710/riscv-z710/riscv-z710.runs/impl_1/Top.bit。
假设你的 Vivado 安装目录是 ~/Xilinx(其他目录自行修改):
@@ -42,6 +39,6 @@ cd vivado/z710
**如果烧板无误，你会看到黄灯亮起**
-
+
后续将上述 program_device.tcl 换成 generate_and_program.tcl 可以将生成比特流和烧板在一个脚本中完成。
\ No newline at end of file
diff --git a/docs/env_doc.md b/docs/env_doc.md
index 32b6a9f..30772b0 100644
--- a/docs/env_doc.md
+++ b/docs/env_doc.md
@@ -17,7 +17,7 @@
在 VSCode 的扩展处搜索 Dev Containers，下载安装
-
+
**使用 Dev Containers 打开项目**
@@ -25,7 +25,7 @@
在上方的运行选项中选择在容器中重新打开，这个命令会让 Dev container 自动根据 devcontainer.json 里的配置信息来创建 Docker 环境
-
+
如果你是第一次在容器中打开，你可能需要十几分钟的时间等待容器配置完毕，如果在配置过程中发生异常，请检查你的网络情况后再次运行
@@ -35,7 +35,7 @@
新建终端输入 sbt test，期望你有如下输出
-
+
```bash
[info] All tests passed.