README.md
1HTML Diff Script for Vulkan
2===========================
3
4This is a first cut at a script to compare Vulkan HTML specifications. Usage
5is simply 'htmldiff file1.html file2.html > diff.html'. The script does not
6copy CSS and images requires by the input specs, so it's best to generate
7the output in the same directory as one of the inputs.
8
9The scripts used require Python and Perl. Additionally, the python
10'utidylib' module and the underlying libtidy C library are required,
11which may make it challenging to run the scripts on non-Linux platforms
12- I haven't checked and those requirements cannot be easily removed. On
13Debian Linux, it may be necessary to install the 'python-utidylib' and
14'libtidy' packages if they are not already present. I haven't checked
15dependencies for other Linux distributions but they are probably
16similar.
17
18The scripts are taken from the code backing the
19
20 http://services.w3.org/htmldiff
21
22website. 'htmldiff' is the Python driver script. 'htmldiff.pl' is the
23Perl script which generates the diff after preprocessing of the input
24HTML by 'htmldiff'. 'htmldiff.orig' is the original Python script from
25the website, modified to run at the command line instead of as a CGI
26script.
27