Skip to content

Commit

Permalink
README: update README (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
Kumonda221-CrO3 authored May 31, 2024
1 parent 4992c86 commit a963329
Showing 1 changed file with 21 additions and 14 deletions.
35 changes: 21 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,30 @@

[![scenario-CoupledL2](https://github.com/OpenXiangShan/tl-test-new/actions/workflows/scenario-CoupledL2.yml/badge.svg?branch=master)](https://github.com/OpenXiangShan/tl-test-new/actions/workflows/scenario-CoupledL2.yml)

> TL-Test-New
> TL-Test-**New**
> The **Unified TileLink Memory Subsystem Tester for XiangShan**
>
>
> **"WELCOME TO THE NEW WORLD !"**
> The Next Generation TL-Test
> ```
> ████████╗██╗ ████████╗███████╗███████╗████████╗ ███╗ ██╗███████╗██╗ ██╗
> ╚══██╔══╝██║ ╚══██╔══╝██╔════╝██╔════╝╚══██╔══╝ ████╗ ██║██╔════╝██║ ██║
> ██║ ██║ █████╗ ██║ █████╗ ███████╗ ██║ █████╗██╔██╗ ██║█████╗ ██║ █╗ ██║
> ██║ ██║ ╚════╝ ██║ ██╔══╝ ╚════██║ ██║ ╚════╝██║╚██╗██║██╔══╝ ██║███╗██║
> ██║ ███████╗ ██║ ███████╗███████║ ██║ ██║ ╚████║███████╗╚███╔███╔╝
> ╚═╝ ╚══════╝ ╚═╝ ╚══════╝╚══════╝ ╚═╝ ╚═╝ ╚═══╝╚══════╝ ╚══╝╚══╝
> ```
### Requirements
* **C/C++ Compiler**: ```GCC 11,12+``` or ```Clang 16,17+```
* **Verilator:** ```Verilator 5.006+```

[**TLDR: Out-of-the-Box Build and Run**](#tldr-out-of-the-box)


## Contents
* [Features](#features)
* [Project tree](#project-tree)
* [**TLDR Out-of-the-Box**](#tldr-out-of-the-box)
* [Getting started](#getting-started)
* [Build and Run](#build-and-run)
* [Configuration](#configuration)
* [**For CoupledL2**](#for-coupledl2)
* [Build](#build)
* [Pre-build Configuration](#pre-build-configuration)
* [Run as Verilator Host](#run-as-verilator-host)
* [Load as DPI Guest](#load-as-dpi-guest)
* [Post-build Configuration](#post-build-configuration)


## Features
Expand All @@ -38,7 +46,6 @@
* [BullsEye Gravity](https://github.com/arch-simulator-sig/BullsEye/tree/master) **EventBus utility** for event-driven extensive controls
* Full support for **ChiselDB** through plug-in
* Detailed and fine-grained controllable verbose information
* Now **zero memory leakage** in TileLink testing sub-system
* Almost zero change required for current L1, L2 RTL design
* **TODO:** TileLink Protocol Analyzer (TLPA - TLEye) through ChiselDB
* **TODO:** XiangShan L1 Trace support
Expand Down Expand Up @@ -212,7 +219,7 @@ make -j `nproc`
make clean
```
## Build Configuration
## Pre-build Configuration
### 1. Paths and executables
#### 1.1 ```CMAKE_CXX_COMPILER```
  Specify the **user-defined C++ compiler** for build-time and run-time procedures on demand.
Expand Down

0 comments on commit a963329

Please sign in to comment.