Skip to content

Commit db9eaea

Browse files
Minor Updates of Documentation
1 parent 6bc578b commit db9eaea

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ To use the package, run
1414
cargo add pytv
1515
```
1616

17+
## Features
18+
### Python Template
19+
This is the basic feature of this package.
20+
21+
### Instantiation
22+
The crate feature `inst` is enabled by default.
23+
YAML contents between `<INST>` and `</INST>` are used to provide instantiation information.
24+
1725
## Related Auto Generator Projects
1826
- **FLAMES**: template-based C++ library for Vitis HLS
1927
[[website](https://flames.autohdw.com)]

src/inst.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ use super::Convert;
22
use std::error::Error;
33
use std::io::Write;
44

5+
/// Represents the state of module instantiation.
56
enum InstState {
67
None,
78
Begin,

src/lib.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
//! Python Templated Verilog
22
//!
33
//! # Generation Process
4-
//! `.pytv` --> `.v.py` --> `.py`
4+
//! ```txt
5+
//! .pytv ----> .v.py --+-> .v
6+
//! |
7+
//! +-> .inst
8+
//! ```
59
//!
610
//! # Examples
711
//! To be added.

0 commit comments

Comments
 (0)