add txt and html, since md not supported by WiX (MSI)
This commit is contained in:
Geoff McLane
parent
59aad805e5
commit
01d35cb22d
45
LICENSE.txt
Normal file
45
LICENSE.txt
Normal file
|
|
@ -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 <dsr@w3.org>
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
124
README.html
Normal file
124
README.html
Normal file
|
|
@ -0,0 +1,124 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<title>
|
||||||
|
HTML Tidy with HTML5 support
|
||||||
|
</title>
|
||||||
|
<style>
|
||||||
|
h1 {
|
||||||
|
background-color: #6495ed;
|
||||||
|
}
|
||||||
|
code {
|
||||||
|
background-color: #e0ffff;
|
||||||
|
}
|
||||||
|
div {
|
||||||
|
background-color: #b0c4de;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>
|
||||||
|
HTML Tidy with HTML5 support
|
||||||
|
</h1>
|
||||||
|
<h2>
|
||||||
|
Prerequisites
|
||||||
|
</h2>
|
||||||
|
<ol>
|
||||||
|
<li>
|
||||||
|
<p>
|
||||||
|
git - http://git-scm.com/book/en/v2/Getting-Started-Installing-Git
|
||||||
|
</p>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<p>
|
||||||
|
cmake - http://www.cmake.org/download/
|
||||||
|
</p>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<p>
|
||||||
|
appropriate build tools for the platform
|
||||||
|
</p>
|
||||||
|
</li>
|
||||||
|
</ol>
|
||||||
|
<p>
|
||||||
|
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.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
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.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
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.
|
||||||
|
</p>
|
||||||
|
<h2>
|
||||||
|
Build the tidy library and command line tool
|
||||||
|
</h2>
|
||||||
|
<ol>
|
||||||
|
<li>
|
||||||
|
<p>
|
||||||
|
<code>cd build/cmake</code>
|
||||||
|
</p>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<p>
|
||||||
|
<code>cmake ../.. [-DCMAKE_INSTALL_PREFIX=/path/for/install]</code>
|
||||||
|
</p>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<p>
|
||||||
|
Windows: <code>cmake --build . --config Release</code>
|
||||||
|
<br>
|
||||||
|
Unix/OS X: <code>make</code>
|
||||||
|
</p>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<p>
|
||||||
|
Install, if desired:
|
||||||
|
<br>
|
||||||
|
Windows: <code>cmake --build . --config Release --target INSTALL</code>
|
||||||
|
<br>
|
||||||
|
Unix/OS X: <code>[sudo] make install</code>
|
||||||
|
</p>
|
||||||
|
</li>
|
||||||
|
</ol>
|
||||||
|
<p>
|
||||||
|
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<em>INSTALL</em>PREFIX=/usr
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
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.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
If you need the tidy library built as a 'shared' (DLL) library, then in 2. add the command
|
||||||
|
-DBUILD<em>SHARED</em>LIB:BOOL=ON. This option is OFF by default, so the static library is
|
||||||
|
built and linked with the command line tool for convenience.
|
||||||
|
</p>
|
||||||
|
<h2>
|
||||||
|
History
|
||||||
|
</h2>
|
||||||
|
<p>
|
||||||
|
This repository should be considered canonical for HTML Tidy as of 2015-January-15.
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<p>
|
||||||
|
This repository originally transferred from <a href=
|
||||||
|
"http://w3c.github.com/tidy-html5/">w3c.github.com/tidy-html5</a>.
|
||||||
|
</p>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<p>
|
||||||
|
First moved to Github from <a href="http://tidy.sourceforge.net">tidy.sourceforge.net</a>.
|
||||||
|
</p>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
Loading…
Reference in a new issue