aboutsummaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorN. Engelhardt <nak@yosyshq.com>2021-03-22 19:16:25 +0100
committerN. Engelhardt <nak@yosyshq.com>2021-03-22 19:16:25 +0100
commitd9ec35a526b9583727ef484ec68bc288dcddb0c8 (patch)
tree01716e03bbb854262fcd128f9c4b3bba5344b751 /manual
parent92d5550a90558a0292c8ac63cecabb2de30eb6aa (diff)
downloadyosys-d9ec35a526b9583727ef484ec68bc288dcddb0c8.tar.gz
yosys-d9ec35a526b9583727ef484ec68bc288dcddb0c8.tar.bz2
yosys-d9ec35a526b9583727ef484ec68bc288dcddb0c8.zip
split CodingReadme into multiple files
Diffstat (limited to 'manual')
-rw-r--r--manual/CHAPTER_Prog.tex11
1 files changed, 6 insertions, 5 deletions
diff --git a/manual/CHAPTER_Prog.tex b/manual/CHAPTER_Prog.tex
index 3cbc95a19..49432f73b 100644
--- a/manual/CHAPTER_Prog.tex
+++ b/manual/CHAPTER_Prog.tex
@@ -5,13 +5,15 @@
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.
+be afraid to ask questions on the YosysHQ Slack.
-\section{The ``CodingReadme'' File}
+\section{Guidelines}
-The following is an excerpt of the {\tt CodingReadme} file from the Yosys source tree.
+The {\tt guidelines} directory contains notes on various aspects of Yosys development. The files {\tt GettingStarted} and {\tt CodingStyle} may be of particular interest, and are reproduced here.
-\lstinputlisting[title=CodingReadme,rangeprefix=--,rangesuffix=--,includerangemarker=false,linerange=snip-snap,numbers=left,frame=single]{../CodingReadme}
+\lstinputlisting[title=GettingStarted,numbers=left,frame=single]{../guidelines/GettingStarted}
+
+\lstinputlisting[title=CodingStyle,numbers=left,frame=single]{../guidelines/CodingStyle}
\section{The ``stubsnets'' Example Module}
@@ -23,4 +25,3 @@ The following is the complete code of the ``stubsnets'' example module. It is in
\lstinputlisting[title=Makefile,numbers=left,frame=single,language=make]{CHAPTER_Prog/Makefile}
\lstinputlisting[title=test.v,numbers=left,frame=single,language=Verilog]{CHAPTER_Prog/test.v}
-