Nyuzi Processor 技术文档

本文档旨在帮助用户安装、使用和理解 Nyuzi Processor 项目。以下是关于该项目的技术文档，包含安装指南、使用说明、项目API使用文档和项目安装方式。

1. 安装指南

Linux (Ubuntu)

Nyuzi Processor 项目需要在 Ubuntu 16 (Xenial Xeres) 或更新版本的操作系统上运行。以下是在终端中执行的命令：

sudo apt-get -y install autoconf cmake make ninja gcc g++ bison flex python \
    python3 perl emacs openjdk-8-jdk swig zlib1g-dev python-dev \
    libxml2-dev libedit-dev libncurses5-dev libsdl2-dev gtkwave python3-pip
pip3 install pillow

注意： 如果遇到 cmake 版本问题，可以参考 此问题 来解决。

MacOS

假设操作系统为 OSX Mavericks 或更高版本。首先从 Mac AppStore 安装 XCode。然后打开终端，执行以下命令安装命令行编译工具：

xcode-select --install

安装 Python 库：

pip3 install pillow

从 https://brew.sh/ 安装 Homebrew，然后使用 Homebrew 安装剩余的包：

brew install cmake bison swig sdl2 emacs ninja

也可以选择使用 MacPorts。

Windows

该项目未在 Windows 上进行测试，但许多库是跨平台的，因此应该可以移植。最简单的方法可能是在 VirtualBox 这样的虚拟机中运行 Linux。

2. 项目的使用说明

安装完所有依赖后，可以通过以下步骤构建和测试项目：

./scripts/setup_tools.sh
cmake .
make
make tests

在 software/apps 目录下有示例应用程序，可以在模拟器中运行它们。例如，运行以下命令可以在模拟器中渲染一个 3D 模型：

cd software/apps/sceneview
./run_emulator

要在 FPGA 上运行，请参考 hardware/fpga/de2-115/README.md 中的说明。

3. 项目API使用文档

目前没有提供详细的API文档。用户可以通过查看项目源代码和示例应用程序来了解如何使用 Nyuzi Processor 的API。

4. 项目安装方式

Nyuzi Processor 项目主要通过源代码安装。首先，克隆项目仓库：

git clone https://github.com/jbush001/NyuziProcessor.git
cd NyuziProcessor

然后按照上述安装指南进行操作。

通过本文档，用户应该能够成功安装、使用 Nyuzi Processor 项目，并对其进行进一步的开发和研究。