update README.md

This commit is contained in:
Zihao Yu 2024-01-10 13:46:20 +08:00
parent 23cd183fea
commit 8a5c368d84
1 changed files with 23 additions and 11 deletions

View File

@ -2,7 +2,7 @@
## 介绍
NVBoard(NJU Virtual Board)是基于SDL开发的虚拟FPGA开发板可以在Verilator仿真环境中模拟FPGA支持LED七段数码管开关键盘和VGA。
NVBoard(NJU Virtual Board)是基于SDL开发的虚拟FPGA开发板可以在Verilator仿真环境中模拟FPGA支持LED七段数码管拨码开关UART键盘和VGA。
## 项目文件说明
@ -12,28 +12,44 @@ NVBoard(NJU Virtual Board)是基于SDL开发的虚拟FPGA开发板可以在Ve
│ └── ...
├── example # 示例项目
│ └── ...
├── include
│   ├── at_scancode.h
├── include # 用于NVboard项目内部包含的头文件
│   ├── component.h
│   ├── configs.h
│   ├── font.h
│   ├── keyboard.h
│   ├── macro.h
│   ├── nvboard.h
│   ├── pins.h
│   ├── render.h
│   ├── term.h
│   ├── uart.h
│   └── vga.h
├── pic # NVBoard图片资源
│ └── ...
├── resources
│   ├── font # 字体资源
│ └── pic # 图片资源
├── scripts
│   ├── auto_pin_bind.py # 生成引脚绑定代码的脚本
│   └── nvboard.mk # NVBoard构建规则
├── src # NVBoard源码
│   ├── at_scancode.h
│ ├── button.cpp
│ ├── component.cpp
│ ├── event.cpp
│ ├── font.cpp
│ ├── keyboard.cpp
│ ├── led.cpp
│ ├── nvboard.cpp
│ ├── render.cpp
│ ├── segs7.cpp
│ ├── switch.cpp
│ ├── term.cpp
│ ├── timer.cpp
│ ├── uart.cpp
│ └── vga.cpp
├── usr
│ └── include # 用于给外部项目包含的头文件
│   ├── nvboard.h
│   └── pins.h
├── LICENSE
└── README.md
```
@ -41,7 +57,7 @@ NVBoard(NJU Virtual Board)是基于SDL开发的虚拟FPGA开发板可以在Ve
## 安装教程
1. 将项目拷贝到本地,`git clone https://github.com/NJU-ProjectN/nvboard.git`
2. 通过`apt-get install libsdl2-dev libsdl2-image-dev`安装SDL2和SDL2-image;对于`macOS`,可以通过`brew install sdl2 sdl2_image`安装
2. 通过`apt-get install libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev`安装SDL2SDL2-image和SDL2-ttf;对于`macOS`,可以通过`brew install sdl2 sdl2_image sdl2_ttf`安装
3. 把本项目的目录设置成环境变量`NVBOARD_HOME`
## 示例
@ -88,7 +104,7 @@ signal (pin1, pin2, ..., pink)
可以在`board`目录下的引脚说明文件中查看引脚信息。
其中`output`表示该信号方向为输出方向(从RTL代码到NVBoard)`input`为输入方向(从NVBoard到RTL代码)。
其中,复位引脚`RST`不使用因为NVBoard在cpp文件中包含一些内部状态仅复位RTL设计部分会使其与NVBoard状态不一致。
目前引脚列表中不包含复位引脚`RST`因为NVBoard在cpp文件中包含一些内部状态仅复位RTL设计部分会使其与NVBoard状态不一致。
一个实现全系统复位效果的简单方法是退出NVBoard并重新运行。RTL设计的复位工作由verilator的wrapper完成具体见`example/csrc/main.cpp`。
### 调用API
@ -125,7 +141,3 @@ include $(NVBOARD_HOME)/scripts/nvboard.mk
* 在生成verilator仿真可执行文件(即`$(NVBOARD_ARCHIVE)`)将这个库文件加入链接过程,并添加链接选项`-lSDL2 -lSDL2_image`
可以参考示例项目中的Makefile文件即`example/Makefile`
## 特技
1. 可以用 `include/configs.h`选择贴图让自己的虚拟FPGA开发板更有特色贴图放在 `pic`目录下;