From 01d35cb22daf998cd22a86d8244447c977588969 Mon Sep 17 00:00:00 2001 From: Geoff McLane Date: Fri, 6 Mar 2015 15:36:42 +0100 Subject: [PATCH] add txt and html, since md not supported by WiX (MSI) --- LICENSE.txt | 45 +++++++++++++++++++ README.html | 124 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 169 insertions(+) create mode 100644 LICENSE.txt create mode 100644 README.html diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..7dfc3a9 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,45 @@ + + Copyright (c) 1998-2015 World Wide Web Consortium + (Massachusetts Institute of Technology, European Research + Consortium for Informatics and Mathematics, Keio University). + All Rights Reserved. + + Contributing Author(s): + + Dave Raggett + + The contributing author(s) would like to thank all those who + helped with testing, bug fixes and suggestions for improvements. + This wouldn't have been possible without your help. + + COPYRIGHT NOTICE: + + This software and documentation is provided "as is," and + the copyright holders and contributing author(s) make no + representations or warranties, express or implied, including + but not limited to, warranties of merchantability or fitness + for any particular purpose or that the use of the software or + documentation will not infringe any third party patents, + copyrights, trademarks or other rights. + + The copyright holders and contributing author(s) will not be held + liable for any direct, indirect, special or consequential damages + arising out of any use of the software or documentation, even if + advised of the possibility of such damage. + + Permission is hereby granted to use, copy, modify, and distribute + this source code, or portions hereof, documentation and executables, + for any purpose, without fee, subject to the following restrictions: + + 1. The origin of this source code must not be misrepresented. + 2. Altered versions must be plainly marked as such and must + not be misrepresented as being the original source. + 3. This Copyright notice may not be removed or altered from any + source or altered source distribution. + + The copyright holders and contributing author(s) specifically + permit, without fee, and encourage the use of this source code + as a component for supporting the Hypertext Markup Language in + commercial products. If you use this source code in a product, + acknowledgment is not required but would be appreciated. + diff --git a/README.html b/README.html new file mode 100644 index 0000000..17590a4 --- /dev/null +++ b/README.html @@ -0,0 +1,124 @@ + + + + + + HTML Tidy with HTML5 support + + + + +

+ HTML Tidy with HTML5 support +

+

+ Prerequisites +

+
    +
  1. +

    + git - http://git-scm.com/book/en/v2/Getting-Started-Installing-Git +

    +
    2. +
  2. +

    + cmake - http://www.cmake.org/download/ +

    +
    3. +
  3. +

    + appropriate build tools for the platform +

    +
    4. +
+

+ 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. +
  2. +

    + cmake ../.. [-DCMAKE_INSTALL_PREFIX=/path/for/install] +

    +
    3. +
  3. +

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

    +
    4. +
  4. +

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

    +
    5. +
+

+ 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 -DCMAKEINSTALLPREFIX=/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 + -DBUILDSHAREDLIB: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. +

+ + +