Skip to content

Commit 01320b6

Browse files
committed
docs: convert README from rst to markdown
1 parent 44999f6 commit 01320b6

3 files changed

Lines changed: 49 additions & 51 deletions

File tree

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
[![Test Suite](https://github.com/ktok07b6/polyphony/actions/workflows/test.yml/badge.svg?branch=devel)](https://github.com/ktok07b6/polyphony/actions/workflows/test.yml)
2+
[![PyPI](https://badge.fury.io/py/polyphony.svg)](https://badge.fury.io/py/polyphony)
3+
[![Python](https://img.shields.io/badge/python-%3E%3D3.12-blue)](https://github.com/ktok07b6/polyphony)
4+
[![License](https://img.shields.io/github/license/ktok07b6/polyphony)](https://github.com/ktok07b6/polyphony/blob/main/LICENSE)
5+
6+
# polyphony
7+
8+
Polyphony is a Python-based High-Level Synthesis (HLS) compiler that generates synthesizable Verilog HDL from a Python subset.
9+
10+
## Requirements
11+
12+
- Python >= 3.12
13+
- Icarus Verilog (for HDL simulation)
14+
15+
## Installation
16+
17+
```bash
18+
pip install polyphony
19+
```
20+
21+
## Usage
22+
23+
```
24+
polyphony [-h] [-o FILE] [-d DIR] [-c CONFIG] [-v] [-D] [-hd] [-q]
25+
[-vd] [-vm] [-op PREFIX] [-t TARGETS [TARGETS ...]] [-V]
26+
source
27+
```
28+
29+
| Option | Description |
30+
|--------|-------------|
31+
| `-o FILE, --output FILE` | output filename (default is "polyphony_out") |
32+
| `-d DIR, --dir DIR` | output directory |
33+
| `-c CONFIG, --config CONFIG` | set configuration (JSON literal or file) |
34+
| `-v, --verbose` | verbose output |
35+
| `-D, --debug` | enable debug mode |
36+
| `-hd, --hdl_debug` | enable HDL debug mode |
37+
| `-q, --quiet` | suppress warning/error messages |
38+
| `-vd, --verilog_dump` | output VCD file in testbench |
39+
| `-vm, --verilog_monitor` | enable $monitor in testbench |
40+
| `-V, --version` | print the Polyphony version number |
41+
42+
## Examples
43+
44+
See [tests](https://github.com/ktok07b6/polyphony/tree/main/tests)
45+
46+
## License
47+
48+
MIT License. See [LICENSE](LICENSE) for details.

README.rst

Lines changed: 0 additions & 50 deletions
This file was deleted.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name = "polyphony"
33
version = "0.4.0"
44
description = "Python based High Level Synthesis compiler"
5-
readme = "README.rst"
5+
readme = "README.md"
66
license = { text = "MIT" }
77
authors = [{ name = "Hiroaki Kataoka", email = "ktok07b6@gmail.com" }]
88
keywords = ["HLS", "High Level Synthesis", "FPGA", "HDL", "Verilog"]

0 commit comments

Comments
 (0)