luke
/
verilator
mirror of https://github.com/verilator/verilator.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Rename readme for github. Commentary.

This commit is contained in:
Wilson Snyder 2015-03-14 13:45:00 -04:00
parent c0df07c86f
commit fb4d462325
3 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Makefile.in
View File

@ -228,16 +228,16 @@ verilator.pdf: ${srcdir}/bin/verilator Makefile
pdflatex verilator.tex pdflatex verilator.tex
-rm -f verilator.toc verilator.aux verilator.idx verilator.out -rm -f verilator.toc verilator.aux verilator.idx verilator.out
README: readme.pod README: README.pod
-rm -f $@ -rm -f $@
$(POD2TEXT) --loose $< > $@ $(POD2TEXT) --loose $< > $@
README.html: readme.pod README.html: README.pod
pod2html $< >$@ pod2html $< >$@
# PDF needs DIST variables; but having configure.ac as dependency isn't detected # PDF needs DIST variables; but having configure.ac as dependency isn't detected
README.pdf: readme.pod Makefile README.pdf: README.pod Makefile
pod2latex --full --out README.tex readme.pod pod2latex --full --out README.tex README.pod
$(PERL) $(POD2LATEXFIX) "$(DISTTITLE) README File" "${DISTDATE}" < README.tex > README2.tex $(PERL) $(POD2LATEXFIX) "$(DISTTITLE) README File" "${DISTDATE}" < README.tex > README2.tex
mv README2.tex README.tex mv README2.tex README.tex
pdflatex README.tex pdflatex README.tex

4
readme.pod → README.pod
View File

@ -5,10 +5,12 @@
=head1 NAME =head1 NAME
This is the Verilator Package README file. This is the Verilator package README file.
=head1 DISTRIBUTION =head1 DISTRIBUTION
http://www.veripool.org/verilator
This package is Copyright 2003-2015 by Wilson Snyder. (Report bugs to This package is Copyright 2003-2015 by Wilson Snyder. (Report bugs to
L<http://www.veripool.org/>.) L<http://www.veripool.org/>.)

12
internals.pod
View File

@ -407,6 +407,18 @@ Tests that fail should by convention have the suffix C<_bad> in their name,
and include C<fails =E<gt> 1> in either their C<compile> or C<execute> step as and include C<fails =E<gt> 1> in either their C<compile> or C<execute> step as
appropriate. appropriate.
=head2 Preparing to Run Tests
For all tests to pass you must install the following packages:
* SystemC to compile the SystemC outputs, see http://systemc.org
* Parallel::Forker from CPAN to run tests in parallel, you can install this
with e.g. "sudo cpan install Parallel::Forker".
* vcddiff to find differences in VCD outputs. See the readme at
https://github.com/veripool/vcddiff
=head2 Controlling the Test Driver =head2 Controlling the Test Driver
Test drivers are written in PERL. All invoke the main test driver script, Test drivers are written in PERL. All invoke the main test driver script,