From c08894195eae1969d47ea0744d40bc2922fb2fc3 Mon Sep 17 00:00:00 2001 From: Geoff McLane Date: Fri, 5 Dec 2014 18:43:42 +0100 Subject: [PATCH] continue process of cleaning up build instructions --- README.html | 147 ++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 114 insertions(+), 33 deletions(-) diff --git a/README.html b/README.html index 05a1eaa..770c304 100644 --- a/README.html +++ b/README.html @@ -1,44 +1,125 @@ - - - - About tidy-html5 + + + + + + About tidy-html5 + + - + + +

+ HTML Tidy for HTML5 +

-

HTML Tidy for HTML5 (experimental)

-

This repo is an experimental fork of the code from - tidy.sourceforge.net. -This source code in this version supports processing of HTML5 documents. -The changes for HTML5 support started from a - patch developed by Björn Höhrmann.

+

+ This repo is an experimental fork of the code from tidy.sourceforge.net. This source code in this version supports + processing of HTML5 documents. +

-

For more information, see - w3c.github.com/tidy-html5 +

+ The changes for HTML5 support started from a patch developed by Björn Höhrmann. A copy of this patch is also + maintained on this site, but naturally a LOT more has been changed in this fork. +

-

Building the tidy command-line tool

-

For Linux/BSD/OSX platforms, you can build and install the -tidy command-line tool from the source code using the -following steps.

+

+ For more information, also see w3c.github.com/tidy-html5 +

-
    -
  1. make -C build/gmake/
    2. -
  2. make install -C build/gmake/
    3. -
+

+ Building tidy with cmake +

-

Note that you will either need to run make install as root, -or with sudo make install.

+

+ For all platforms, you can build and install the tidy command-line tool from the + source code using the following steps. +

-

Building the libtidy shared library

-

For Linux/BSD/OSX platforms, you can build and install the -tidylib shared library (for use in building other -applications) from the source code using the following steps.

+ + +

+ Alternatively the CMake GUI can be used. CMake options can be read from their site, and/or running # cmake --help to get help, and view the + 'generators' supported on your platform. +
+ The build/cmake folder contains sample windows (batch) and unix (sh) scripts which can be + adjusted to suit your choices. +

+ +

+ This document has been tidied using tidy5.exe, using a configuration file, tidy5.cfg containing + - +

+ + 
+tidy-mark: no
+indent: yes
+break-before-br: yes
+indent-attributes: yes
+vertical-space: yes
+indent-spaces: 1
+indent-cdata: no
+wrap-asp: no
+wrap-attributes: no
+wrap-jste: no
+wrap-php: no
+wrap-script-literals: no
+wrap-sections: no
+tab-size: 4
+show-info: no
+
+

+ Using the following command +
+ tidy5 -o README5.html -config tidy5.cfg README.html +
+ then after checking README.html is deleted, and README5.html renamed to README.html +

+ +

+ README.html 20141205 +

+ +