Skip to content

Commit cd3276e

Browse files
committed
Adding examples
1 parent 9206757 commit cd3276e

1 file changed

Lines changed: 21 additions & 4 deletions

File tree

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,36 @@ pip install -e .
1919

2020
# Quick Start Quide
2121

22-
## Synthesis Examples
22+
## Basic synthesis
2323

24-
**Run `basic` benchmarks**
24+
The project includes a basic baremetal script that loops over a set of benchmarks and provides a summary of the results.
25+
26+
**Example: Run `basic` group**
2527
```sh
2628
python examples/baremetal/make.py -g basic
2729
```
2830

29-
**Clean build dir and then run `arithmetic` and `basic' benchmarks
31+
**Example: Run multiple groups**
32+
```sh
33+
python examples/baremetal/make.py -g basic arithmetic
34+
```
35+
36+
**Example: Specify a single benchmark**
37+
```sh
38+
python examples/baremetal/make.py -g basic arithmetic -n add
39+
```
40+
41+
**Example: Specify name of output file**
42+
```sh
43+
python examples/baremetal/make.py -g basic arithmetic -n add -o results.csv
44+
```
45+
46+
**Example: Clean up before running**
3047
```sh
3148
python examples/baremetal/make.py -g basic arithmetic -clean
3249
```
3350

34-
**Run a single `memory` benchmark in vivado
51+
**Example: Run a single benchmark in vivado**
3552
```sh
3653
python examples/baremetal/make.py -g memory -name ramsp -tool vivado
3754
```

0 commit comments

Comments
 (0)