From fb4d462325522ede3eb07aa71c7ef16bd07d8360 Mon Sep 17 00:00:00 2001
From: Wilson Snyder <wsnyder@wsnyder.org>
Date: Sat, 14 Mar 2015 13:45:00 -0400
Subject: [PATCH] Rename readme for github. Commentary.

---
 Makefile.in              |  8 ++++----
 readme.pod => README.pod |  4 +++-
 internals.pod            | 12 ++++++++++++
 3 files changed, 19 insertions(+), 5 deletions(-)
 rename readme.pod => README.pod (98%)

diff --git a/Makefile.in b/Makefile.in
index 7c3aa5e7a..57a8db9b7 100644
--- a/Makefile.in
+++ b/Makefile.in
@@ -228,16 +228,16 @@ verilator.pdf: ${srcdir}/bin/verilator Makefile
 	pdflatex verilator.tex
 	-rm -f verilator.toc verilator.aux verilator.idx verilator.out
 
-README: readme.pod
+README: README.pod
 	-rm -f $@
 	$(POD2TEXT) --loose $< > $@
 
-README.html: readme.pod
+README.html: README.pod
 	pod2html $< >$@
 
 # PDF needs DIST variables; but having configure.ac as dependency isn't detected
-README.pdf: readme.pod Makefile
-	pod2latex --full --out README.tex readme.pod
+README.pdf: README.pod Makefile
+	pod2latex --full --out README.tex README.pod
 	$(PERL) $(POD2LATEXFIX) "$(DISTTITLE) README File" "${DISTDATE}" < README.tex > README2.tex
 	mv README2.tex README.tex
 	pdflatex README.tex
diff --git a/readme.pod b/README.pod
similarity index 98%
rename from readme.pod
rename to README.pod
index e9848627e..8ac7e72df 100644
--- a/readme.pod
+++ b/README.pod
@@ -5,10 +5,12 @@
 
 =head1 NAME
 
-This is the Verilator Package README file.
+This is the Verilator package README file.
 
 =head1 DISTRIBUTION
 
+http://www.veripool.org/verilator
+
 This package is Copyright 2003-2015 by Wilson Snyder.  (Report bugs to
 L<http://www.veripool.org/>.)
 
diff --git a/internals.pod b/internals.pod
index ddc8b4bba..aa68ecefd 100644
--- a/internals.pod
+++ b/internals.pod
@@ -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
 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
 
 Test drivers are written in PERL. All invoke the main test driver script,