Commits

Michael[tm] Smith committed 63f15f8

updated

Comments (0)

Files changed (1)

-## Using
+There are two ways you can use the code here to validate documents:
 
-There are two ways you can use the code here to validate documents: (A) Use
-the pre-built vnu.jar and vnu-fast-client.jar files, or (B) download,
-build, and run the validator from the sources. This section explains how to
-use the pre-built jar files. For information on how to download, build, and
-run the validator from the sources, see the next major section.
+* Download, build, and run the validator from the sources; or
+* Use the pre-built `vnu.jar` and `vnu-fast-client.jar` files
+  
+For information on using using the `vnu.jar` and `vnu-fast-client.jar`
+files, see the *Pre-built jars* section below.
+
+## How to download, build, and run the validator from the sources
+
+First, set the JAVA_HOME environment variable properly.
+
+On Ubuntu:
+
+    export JAVA_HOME=/usr/lib/jvm/java-6-openjdk
+
+On Mac OS X:
+
+    export JAVA_HTML=/Library/Java/Home
+
+Next, create a validator workspace.
+
+    mkdir checker
+    cd checker
+    hg clone https://bitbucket.org/validator/build build
+
+The above steps create a `checker` directory in which the build script will
+create other subdirectories, and downloads the `build.py` script itself
+into a `build` subdirectory in your `checker` directory.
+
+Finally, run the build script.
+
+    python build/build.py all
+    python build/build.py all
+
+Yes, the last line is there twice intentionally. Running the script twice tends
+to fix a `ClassCastException` on the first run.
+
+The above steps will download, build and run the system at `http://localhost:8888/`.
+For other options, please run `python build/build.py --help` instead.
+
+Please note that the dependencies are big. The script will spend time
+downloading stuff. The script requires Python, Mercurial, Subversion and JDK 5
+or later (JDK 6 and Hardy’s OpenJDK work). (Tested on Mac OS X and Ubuntu with
+the openjdk-6-jdk package.)
+
+Note: The script wants to see a Sun-compatible jar executable. Debian fastjar
+will not work.
+
+## Deployment
+
+The above example starts a standalone HTTP server with debug messages printed to
+the console. To use AJP13 instead, use `--ajp=on`. A log4j configuration for
+deployment can be given using the `--log4j=` option. There is a sample file in
+`validator/log4j-deployment-sample.properties`. The directory `extras/` is
+searched for additional jars for the classpath. For example, if you configure
+log4j to send email, you should put the Java Mail API and JavaBeans Activation
+Framework jars in extras/.
 
 You can validate a single document by doing this:
 
 
     possible values: yes or no
 
-## How to download, build, and run the validator from the sources
-
-First, set the JAVA_HOME environment variable properly.
-
-On Ubuntu:
-
-    export JAVA_HOME=/usr/lib/jvm/java-6-openjdk
-
-On Mac OS X:
-
-    export JAVA_HTML=/Library/Java/Home
-
-Next, create a validator workspace.
-
-    mkdir checker
-    cd checker
-    hg clone https://bitbucket.org/validator/build build
-
-The above steps create a `checker` directory in which the build script will
-create other subdirectories, and downloads the `build.py` script itself
-into a `build` subdirectory in your `checker` directory.
-
-Finally, run the build script.
-
-    python build/build.py all
-    python build/build.py all
-
-Yes, the last line is there twice intentionally. Running the script twice tends
-to fix a `ClassCastException` on the first run.
-
-The above steps will download, build and run the system at `http://localhost:8888/`.
-For other options, please run `python build/build.py --help` instead.
-
-Please note that the dependencies are big. The script will spend time
-downloading stuff. The script requires Python, Mercurial, Subversion and JDK 5
-or later (JDK 6 and Hardy’s OpenJDK work). (Tested on Mac OS X and Ubuntu with
-the openjdk-6-jdk package.)
-
-Note: The script wants to see a Sun-compatible jar executable. Debian fastjar
-will not work.
-
-## Deployment
-
-The above example starts a standalone HTTP server with debug messages printed to
-the console. To use AJP13 instead, use `--ajp=on`. A log4j configuration for
-deployment can be given using the `--log4j=` option. There is a sample file in
-`validator/log4j-deployment-sample.properties`. The directory `extras/` is
-searched for additional jars for the classpath. For example, if you configure
-log4j to send email, you should put the Java Mail API and JavaBeans Activation
-Framework jars in extras/.
-