From 979ed8ace2dc97817910c2e97a2e8ab5cd92e313 Mon Sep 17 00:00:00 2001
From: Tom Copeland <tomcopeland@users.sourceforge.net>
Date: Mon, 24 Jun 2002 14:54:21 +0000
Subject: [PATCH] *** empty log message ***

git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@10 51baf565-9d33-0410-a72c-fc3788e3496d
---
 pmd/docs/index.html |  2 +-
 pmd/docs/readme.txt | 10 ++++++++++
 2 files changed, 11 insertions(+), 1 deletion(-)
 create mode 100644 pmd/docs/readme.txt

diff --git a/pmd/docs/index.html b/pmd/docs/index.html
index 51abbb967a..b0ce8c3051 100644
--- a/pmd/docs/index.html
+++ b/pmd/docs/index.html
@@ -15,7 +15,7 @@
 <br>Thanks to <a href="http://www.webgain.com/products/java_cc/">Webgain</a> for hosting JavaCC.
 <p><b>Developers</b>
 <br>Tom Copeland
-<br>David Peugh
+<br>David Dixon-Peugh
 <p><b>Similar projects</b>
 <br><a href="http://doctorj.org/">DoctorJ</a> - open source, written in C++, checks Javadoc, syntax, and calculates metrics
 <br><A href="http://www.parasoft.com">JTest</a> - commercial product, very nice with tons of features, but also very expensive and requires a running X server (or Xvfb) to run on Linux.  They charge $500 to move a license from one machine to another.
diff --git a/pmd/docs/readme.txt b/pmd/docs/readme.txt
new file mode 100644
index 0000000000..32b3f9e379
--- /dev/null
+++ b/pmd/docs/readme.txt
@@ -0,0 +1,10 @@
+Here's how to use PMD:
+
+1) Check out the source code
+2) Change to the etc directory - "cd etc"
+3) run the scp.bat file - "scp"
+3) Make sure you have Ant 1.4.1 installed
+4) Run the Ant build file - "ant clean"
+5) write a small Ant target that uses PMD (see etc/build.xml for an example)
+6) Run the Ant target - "ant pmd"
+7) This generates a text file contained problem names and line numbers
\ No newline at end of file