Skip to content

0xtaruhi/ufde-next

Repository files navigation

UFDE+ Logo

UFDE+

Status GitHub Issues GitHub Pull Requests License


UFDE+ is a new generation of FPGA integrated design environment from synthesis to implementation for Fudan University's self-developed FPGAs.

📝 Table of Contents

🧐 About

UFDE+ is a new generation of FPGA integrated design environment from synthesis to implementation for Fudan University's self-developed FPGAs. It is designed to be a complete and easy-to-use FPGA design environment. UFDE+ is a cross-platform application based on the Tauri framework, which can run on Windows, Linux and macOS.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Rust & Cargo

Install Rust and Cargo first. Recommended installation method is via rustup.

pnpm

Install pnpm first. Optionally, you can use npm or yarn instead.

Cmake

Install Cmake

Clang

We recommend using Clang as the C/C++ compiler on the Linux and macOS platforms. On Windows, you can use MSVC(tested) or MinGW instead.

Installing

Clone the repository

git clone https://github.com/0xtaruhi/ufde-next.git

Build FDE CLI

The FDE Command Line Interface (FDE CLI) is a command line tool for FPGA design. It is written in C++ and it is the core of UFDE+. Although I've tried to clean all the warnings, there may still be some warnings when compiling. Just ignore them.

FDE CLI is a submodule of UFDE+. So you need to initialize the submodule first:

git submodule update --init --recursive

Then, run the following command to build FDE CLI:

cd public/FDE-Source
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build . && cmake --install .

You can find the built FDE CLI in the public/FDE-Source/build/bin directory.

Note:

  1. If you are using MSVC on Windows, you need to add the --config Release option to the cmake --build . command.
  2. On macOS, the error ld: library 'icudata' not found may occur when building FDE CLI. You can fix this by running the following command: (Surely you need to install this library via Homebrew)
export LIBRARY_PATH=${LIBRARY_PATH}:/usr/local/opt/icu4c/lib
  1. IMPORTANT: DO NOT CHANGE THE BUILD DIRECTORY NAME!

Build UFDE+

Change the current directory to the root directory of UFDE+ and run the following command to install the dependencies:

pnpm install

Then, run the following command to start the application:

pnpm tauri dev

This will start the application in development mode. You can also build the application by running the following command:

pnpm tauri build

This will build the application for your current platform. You can find the built application in the src-tauri/target/release directory.

✍️ Authors