emelie/tidy-html5
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
402 commits 6 branches 8 tags 6.6 MiB
C 48.7%
Gettext Catalog 23.9%
HTML 21.8%
C++ 3.1%
Ruby 1.7%
Other 0.7%
Go to file
Geoff McLane f5eb2cf26a Issue #196 - expand comment and bump version. 
Thanks to @willydee for this PR.
2015-04-11 15:25:07 +02:00
build add more to clean up 2015-04-02 17:36:05 +02:00
console add small 'sample' API use, optional build 2015-02-07 15:33:13 +01:00
experimental new 2011-11-17 11:44:16 +09:00
include Squelch documentation building errors. 2015-03-08 11:34:17 +08:00
src Issue #196 - expand comment and bump version. 2015-04-11 15:25:07 +02:00
test Issue #168 alter 2 cases, 5-5-1-3 and 5-6-1-3 to expect what is output now. 2015-03-05 13:36:59 +01:00
.gitignore .gitignore cleanup 2015-02-14 13:55:39 +08:00
CMakeLists.txt prepare for changing the lib name 2015-04-02 13:17:14 +02:00
LICENSE.md Changed license to markdown. 2015-02-13 10:35:14 +08:00
LICENSE.txt add txt and html, since md not supported by WiX (MSI) 2015-03-06 15:36:42 +01:00
README.html add txt and html, since md not supported by WiX (MSI) 2015-03-06 15:36:42 +01:00
README.md correct spelling and add options 2015-02-27 17:50:43 +01:00
version.txt Issue #196 - expand comment and bump version. 2015-04-11 15:25:07 +02:00

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 parameters 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 tidy 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

By default cmake sets the install path to /usr/local in unix. If you wanted the binary in say /usr/bin instead, then in 2. above use -DCMAKE_INSTALL_PREFIX=/usr

In windows the default install is to C:\Program Files\tidy5, or C:/Program Files (x86)/tidy5, which is not very useful. After the build the tidy[n].exe is in the Release directory, and can be copied to any directory in your PATH environment variable, for global use.

If you need the tidy library built as a 'shared' (DLL) library, then in 2. add the command -DBUILD_SHARED_LIB:BOOL=ON. This option is OFF by default, so the static library is built and linked with the command line tool for convenience.

History

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