tidy-html5/README.md

# HTML Tidy with HTML5 support

## Prerequisites

  1. git - http://git-scm.com/book/en/v2/Getting-Started-Installing-Git
  
  2. cmake - http://www.cmake.org/download/
  
  3. appropriate build tools for the platform
  
CMake comes in two forms - command line and gui. Some installations only install one or the other, but sometimes both. The build commands below are only for the command line use.

Also the actual build tools vary for each platform. But that is one of the great features of cmake, it can generate variuous 'native' build files. Running cmake without any paramaters will list the generators available on that platform. For sure one of the common ones is "Unix Makefiles", which needs autotools make installed, but many other generators are supported.

In windows cmake offers various versions of MSVC. Again below only the command line use of MSVC is shown, but the tiyd solution (*.sln) file can be loaded into the MSVC IDE, and the building done in there.


## Build the tidy library and command line tool

  1. `cd build/cmake`

  2. `cmake ../.. [-DCMAKE_INSTALL_PREFIX=/path/for/install]`

  3. Windows:  `cmake --build . --config Release`  
     Unix/OS X: `make`

  4. Install, if desired:  
     Windows: `cmake --build . --config Release --target INSTALL`  
     Unix/OS X: `[sudo] make install`


## History

This repository should be considered canonical for HTML Tidy as of 2015-January-15.

 - This repository originally transferred from [w3c.github.com/tidy-html5][1].
 
 - First moved to Github from [tidy.sourceforge.net][2].


   [1]: http://w3c.github.com/tidy-html5/

   [2]: http://tidy.sourceforge.net
merge of develop-500 into master 2015-02-27 11:53:53 +00:00			`# HTML Tidy with HTML5 support`
Update README.md 2015-02-12 12:11:06 +00:00
merge of develop-500 into master 2015-02-27 11:53:53 +00:00			`## Prerequisites`
Update README.md 2015-02-12 12:11:06 +00:00
merge of develop-500 into master 2015-02-27 11:53:53 +00:00			`1. git - http://git-scm.com/book/en/v2/Getting-Started-Installing-Git`

			`2. cmake - http://www.cmake.org/download/`

			`3. appropriate build tools for the platform`

			`CMake comes in two forms - command line and gui. Some installations only install one or the other, but sometimes both. The build commands below are only for the command line use.`
new 2011-11-17 02:58:38 +00:00
merge of develop-500 into master 2015-02-27 11:53:53 +00:00			`Also the actual build tools vary for each platform. But that is one of the great features of cmake, it can generate variuous 'native' build files. Running cmake without any paramaters will list the generators available on that platform. For sure one of the common ones is "Unix Makefiles", which needs autotools make installed, but many other generators are supported.`
new 2011-11-17 02:58:38 +00:00
merge of develop-500 into master 2015-02-27 11:53:53 +00:00			`In windows cmake offers various versions of MSVC. Again below only the command line use of MSVC is shown, but the tiyd solution (*.sln) file can be loaded into the MSVC IDE, and the building done in there.`
new 2011-11-17 02:58:38 +00:00

Removed unnecessary README.html (redundant). Updated README.md for legibility. Will add deleted credits to documentation. 2015-01-31 10:09:33 +00:00			`## Build the tidy library and command line tool`
Link to home page in readme. 2012-03-15 02:49:03 +00:00
Removed unnecessary README.html (redundant). Updated README.md for legibility. Will add deleted credits to documentation. 2015-01-31 10:09:33 +00:00			1. `cd build/cmake`
Link to home page in readme. 2012-03-15 02:49:03 +00:00
Removed unnecessary README.html (redundant). Updated README.md for legibility. Will add deleted credits to documentation. 2015-01-31 10:09:33 +00:00			2. `cmake ../.. [-DCMAKE_INSTALL_PREFIX=/path/for/install]`
Add info about building shared lib. Fixes #25. Thanks Chris Love. 2012-03-27 15:41:17 +00:00
Removed unnecessary README.html (redundant). Updated README.md for legibility. Will add deleted credits to documentation. 2015-01-31 10:09:33 +00:00			3. Windows: `cmake --build . --config Release`
			Unix/OS X: `make`
new 2011-11-17 02:58:38 +00:00
Removed unnecessary README.html (redundant). Updated README.md for legibility. Will add deleted credits to documentation. 2015-01-31 10:09:33 +00:00			`4. Install, if desired:`
			Windows: `cmake --build . --config Release --target INSTALL`
			Unix/OS X: `[sudo] make install`
new 2011-11-17 02:58:38 +00:00
further tweak build instructions 2011-11-18 13:58:14 +00:00
Removed unnecessary README.html (redundant). Updated README.md for legibility. Will add deleted credits to documentation. 2015-01-31 10:09:33 +00:00			`## History`
new 2011-11-17 02:58:38 +00:00
Removed unnecessary README.html (redundant). Updated README.md for legibility. Will add deleted credits to documentation. 2015-01-31 10:09:33 +00:00			`This repository should be considered canonical for HTML Tidy as of 2015-January-15.`
Add info about building shared lib. Fixes #25. Thanks Chris Love. 2012-03-27 15:41:17 +00:00
Removed unnecessary README.html (redundant). Updated README.md for legibility. Will add deleted credits to documentation. 2015-01-31 10:09:33 +00:00			`- This repository originally transferred from [w3c.github.com/tidy-html5][1].`

			`- First moved to Github from [tidy.sourceforge.net][2].`
Add info about building shared lib. Fixes #25. Thanks Chris Love. 2012-03-27 15:41:17 +00:00

Removed unnecessary README.html (redundant). Updated README.md for legibility. Will add deleted credits to documentation. 2015-01-31 10:09:33 +00:00			`[1]: http://w3c.github.com/tidy-html5/`
update README.md for using cmake 2014-08-03 19:14:48 +00:00
Removed unnecessary README.html (redundant). Updated README.md for legibility. Will add deleted credits to documentation. 2015-01-31 10:09:33 +00:00			`[2]: http://tidy.sourceforge.net`
Add info about building shared lib. Fixes #25. Thanks Chris Love. 2012-03-27 15:41:17 +00:00