Commits

Michael[tm] Smith committed 09167fa

Updated README.

  • Participants
  • Parent commits f8e32ab

Comments (0)

Files changed (2)

 ## How to download, build, and run the validator
 
   1. First, set the JAVA_HOME environment variable properly.
-     On Ubuntu:
 
-      `export JAVA_HOME=/usr/lib/jvm/java-6-openjdk`
+On Ubuntu:
 
-     On Mac OS X:
 
-      `export JAVA_HTML=/Library/Java/Home`
+      export JAVA_HOME=/usr/lib/jvm/java-6-openjdk
+
+On Mac OS X:
+
+
+      export JAVA_HTML=/Library/Java/Home
 
   2. 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.
 
-  3. Run the build script.
+The above steps creates 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.
+
+  3. > 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.
+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
 ## jars
 
 [more info later]
+
+foo here
+
+    bar here
+

File README.markdown

 
 There are two ways you can use the code here to do validate documents:
 
-  A. Use the pre-built vnu.jar and vnu-fast-client.jar files
+1. Use the pre-built vnu.jar and vnu-fast-client.jar files
 
   or
 
-  B. Download, build, and run the validator from the sources
+2. 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
 
 You can validate a single document by doing this:
 
-  `java -jar vnu.jar FILE.html`
+    `java -jar vnu.jar FILE.html`
 
 You can batch-validate multiple files at once by doing this:
 
-  `java -jar vnu.jar FILE.html FILE2.html FILE3.HTML FILE4.html...`
+    `java -jar vnu.jar FILE.html FILE2.html FILE3.HTML FILE4.html...`
 
 Or by doing something like this:
 
-  `java -jar vnu.jar $(find . -name "*.html")`
+    `java -jar vnu.jar $(find . -name "*.html")`
 
 ### Faster validation
 
 
 To do that, you first need to start the validator by doing this:
 
-  `java -cp vnu.jar nu.validator.servlet.Main 8888`
+    `java -cp vnu.jar nu.validator.servlet.Main 8888`
 
 (To have the validator listen on a different port, replace `8888` with the
 port number.)
 In a separate console window, you can validate a single document by doing
 this:
 
-  `java -jar vnu-fast-client.jar FILE.html`
+    `java -jar vnu-fast-client.jar FILE.html`
 
 You can batch-validate multiple files at once by doing this:
 
-  `java -jar vnu-fast-client.jar FILE.html FILE2.html FILE3.HTML...`
+    `java -jar vnu-fast-client.jar FILE.html FILE2.html FILE3.HTML...`
 
 Or by doing something like this:
 
-  `java -jar vnu-fast-client.jar $(find . -name "*.html")`
+    `java -jar vnu-fast-client.jar $(find . -name "*.html")`
 
 ### Configuration
 
 These properties map to the Validator.nu common input parameters documented
 at http://wiki.whatwg.org/wiki/Validator.nu_Common_Input_Parameters
 
-nu.validator.client.host
+* nu.validator.client.host
 
-    Specifies the hostname of the validator for the client to connect to.
+  Specifies the hostname of the validator for the client to connect to.
 
-    default: `127.0.0.1`
+  default: `127.0.0.1`
 
 nu.validator.client.port