Writing Docs

Cargo.toml

@@ -3,12 +3,13 @@ name = "pytv"
 description = "Python Templated Verilog"
 repository = "https://github.com/autohdw/pytv"
 authors = ["Teddy van Jerry <me@teddy-van-jerry.org>"]
-version = "0.5.5"
+version = "0.5.6"
 readme = "README.md"
 license = "GPL-3.0-or-later"
 keywords = ["verilog", "python", "template", "generation"]
 categories = ["template-engine", "compilers", "development-tools"]
 exclude = [
+    "docs/*",
     "examples/*",
     "target/*",
     "Cargo.lock",

docs/pytv-docs.tex

@@ -0,0 +1,39 @@
+\documentclass{article}
+\usepackage{cite}
+\usepackage[hidelinks]{hyperref}
+
+\newcommand{\pytvversion}{0.5.6}
+
+\title{PyTV: Python Templated Verilog}
+\author{Wuqiong Zhao}
+
+\begin{document}
+
+\maketitle
+
+\begin{abstract}
+  PyTV (Python Templated Verilog)%
+  \footnote{This is the documentation to PyTV version \texttt{\pytvversion{}}.}
+  is a Rust library and binary tool that extends Verilog with Python templating.
+\end{abstract}
+
+\tableofcontents
+
+\section{Introduction}\label{sec:introduction}
+\input{sections/introduction}
+
+\section{Installation}\label{sec:installation}
+\input{sections/installation}
+
+\section{Syntax Specifications}\label{sec:syntax}
+\input{sections/syntax}
+
+\bibliographystyle{IEEEtran}
+\phantomsection
+\addcontentsline{toc}{section}{References}
+\bgroup
+\small
+\bibliography{IEEEabrv, ref}
+\egroup
+
+\end{document}

docs/sections/introduction.tex

@@ -0,0 +1,9 @@
+% Templated languages
+One method of auto generation of parameterized hardware relies on templated languages.
+AHDW \cite{zhao2023automatic} is a language building upon Verilog with custom syntax for parameterized hardware.
+% PyTV's advantage
+
+% PyTV project information
+PyTV is open-source at \url{https://github.com/autohdw/pytv}
+and is distributed under the GPL-3.0 license.
+The Rust crate is available at \url{https://crates.io/crates/pytv}.