Update Documentation

Cargo.toml

@@ -3,7 +3,7 @@ name = "pytv"
 description = "Python Templated Verilog"
 repository = "https://github.com/autohdw/pytv"
 authors = ["Teddy van Jerry <me@teddy-van-jerry.org>"]
-version = "0.1.0"
+version = "0.1.1"
 readme = "README.md"
 license = "GPL-3.0-or-later"
 keywords = ["verilog", "python", "template", "generation"]

README.md

@@ -1,14 +1,24 @@
 # pytv
 Python Templated Verilog
 
-## Packages
-The package is available on [crates.io](https://crates.io/crates/pytv).
+## Package
+The package `pytv` is available on [crates.io](https://crates.io/crates/pytv).
 Documentation is available on [docs.rs](https://docs.rs/pytv).
 
 To use the package, run
 ```sh
 cargo add pytv
 ```
 
+# Related Auto Generator Projects
+- **FLAMES**: template-based C++ library for Vitis HLS
+  [[website](https://flames.autohdw.com)]
+  [[GitHub](https://github.com/autohdw/flames)]
+  [[paper at IEEE](https://ieeexplore.ieee.org/document/10437992)]
+  [[paper PDF](https://wqzhao.org/assets/zhao2024flexible.pdf)]
+- **AHDW**: a DSL, the predecessor of this project
+  [[paper at IEEE](https://ieeexplore.ieee.org/document/10396119)]
+  [[paper PDF](https://wqzhao.org/assets/zhao2023automatic.pdf)]
+
 ## Author
 [Teddy van Jerry](https://github.com/Teddy-van-Jerry) ([Wuqiong Zhao](https://wqzhao.org))

src/convert.rs

@@ -3,7 +3,7 @@ use crate::FileOptions;
 use std::io::{Result, Write};
 use std::path;
 
-/// The `Convert` struct represents a converter that converts PYTV script to Python script to generate Verilog.
+/// Represents a converter that converts PYTV script to Python script to generate Verilog.
 ///
 /// It is also possible to run the Python script after conversion and optionally delete it after running it.
 /// It contains methods for converting code and managing input/output files.

src/lib.rs

@@ -1,3 +1,20 @@
+//! Python Templated Verilog
+//! 
+//! # Generation Process
+//! `.pytv` --> `.v.py` --> `.py`
+//! 
+//! # Examples
+//! To be added.
+//! 
+//! # Related Auto Generator Projects
+//! - **FLAMES**: template-based C++ library for Vitis HLS
+//!   [[website](https://flames.autohdw.com)]
+//!   [[GitHub](https://github.com/autohdw/flames)]
+//!   [[paper at IEEE](https://ieeexplore.ieee.org/document/10437992)]
+//!   [[paper PDF](https://wqzhao.org/assets/zhao2024flexible.pdf)]
+//! - **AHDW**: a DSL, the predecessor of this project
+//!   [[paper at IEEE](https://ieeexplore.ieee.org/document/10396119)]
+//!   [[paper PDF](https://wqzhao.org/assets/zhao2023automatic.pdf)]
 mod config;
 mod convert;