Skip to content

Commit

Permalink
Minor Updates of Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Teddy-van-Jerry committed Mar 17, 2024
1 parent 6bc578b commit db9eaea
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ To use the package, run
cargo add pytv
```

## Features
### Python Template
This is the basic feature of this package.

### Instantiation
The crate feature `inst` is enabled by default.
YAML contents between `<INST>` and `</INST>` are used to provide instantiation information.

## Related Auto Generator Projects
- **FLAMES**: template-based C++ library for Vitis HLS
[[website](https://flames.autohdw.com)]
Expand Down
1 change: 1 addition & 0 deletions src/inst.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ use super::Convert;
use std::error::Error;
use std::io::Write;

/// Represents the state of module instantiation.
enum InstState {
None,
Begin,
Expand Down
6 changes: 5 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
//! Python Templated Verilog
//!
//! # Generation Process
//! `.pytv` --> `.v.py` --> `.py`
//! ```txt
//! .pytv ----> .v.py --+-> .v
//! |
//! +-> .inst
//! ```
//!
//! # Examples
//! To be added.
Expand Down

0 comments on commit db9eaea

Please sign in to comment.