diff options
author | Clifford Wolf <clifford@clifford.at> | 2014-12-31 14:26:54 +0100 |
---|---|---|
committer | Clifford Wolf <clifford@clifford.at> | 2014-12-31 14:28:27 +0100 |
commit | 539dd805f44ece3e39f4c68e4ea1bdc9b662e83f (patch) | |
tree | aa9756612d2d42da9a633e5ec9a6d7fdc4b3c53d /manual | |
parent | ba48b6b1e6fb962428c0e4ce4a3f0fb3a5cd59eb (diff) | |
download | yosys-539dd805f44ece3e39f4c68e4ea1bdc9b662e83f.tar.gz yosys-539dd805f44ece3e39f4c68e4ea1bdc9b662e83f.tar.bz2 yosys-539dd805f44ece3e39f4c68e4ea1bdc9b662e83f.zip |
Improvements in CodingReadme
Diffstat (limited to 'manual')
-rw-r--r-- | manual/CHAPTER_Prog.tex | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/manual/CHAPTER_Prog.tex b/manual/CHAPTER_Prog.tex index 3918594a2..3cbc95a19 100644 --- a/manual/CHAPTER_Prog.tex +++ b/manual/CHAPTER_Prog.tex @@ -2,16 +2,21 @@ \chapter{Programming Yosys Extensions} \label{chapter:prog} -\begin{fixme} -This chapter will contain a guided tour to the Yosys APIs and conclude -with an example module. -\end{fixme} +This chapter contains some bits and pieces of information about programming +yosys extensions. Also consult the section on programming in the ``Yosys +Presentation'' (can be downloaded from the Yosys website as PDF) and don't +be afraid to ask questions on the Yosys Subreddit. -\section{Programming with RTLIL} -\section{Internal Utility Libraries} -\section{Loadable Modules} +\section{The ``CodingReadme'' File} + +The following is an excerpt of the {\tt CodingReadme} file from the Yosys source tree. + +\lstinputlisting[title=CodingReadme,rangeprefix=--,rangesuffix=--,includerangemarker=false,linerange=snip-snap,numbers=left,frame=single]{../CodingReadme} + +\section{The ``stubsnets'' Example Module} + +The following is the complete code of the ``stubsnets'' example module. It is included in the Yosys source distribution as {\tt manual/CHAPTER\_Prog/stubnets.cc}. -\section{Example Module} \lstinputlisting[title=stubnets.cc,numbers=left,frame=single,language=C++]{CHAPTER_Prog/stubnets.cc} |