=== Basics ===

dapscompare is a tool for comparing documentation output. It has two main
modes:
- Reference mode: build the initial set of reference images
- Compare mode: build a set of images that can be compared to the reference set

dapscompare searches in all subdirectories of the testcases folder for DC
files and builds PDFs and HTML from those. It starts as many threads as
there are CPU cores available.

=== Requirements ===

dapscompare requires DAPS and Python 3. Additionally, use pip or the package
manager of your operating system to install:
- PyQt4
- SciPy
- Numpy
- Pillow (PIL fork)

On openSUSE 42.2, run:
# zypper in python3-tk python3-qt4
# pip3 install Pillow scipy numpy

=== Commands ===

reference	Builds all DC files contained in sub folders of the
		testcases folder and stores images of all pages in
		the dapscompare-reference folders.
				
compare		Builds all DC files contained in sub folders of the
		testcases folder and subtracts them from the reference
		images.
		
view		Don't build files, just view results of last run and
		compare differing images in GUI if available.

clean		Remove all temporary files from working directories. Run
		the clean command before you use reference for the first
		time.
		
=== Parameters ===
		
--daps=''	Allows to pass any parameters to daps. The base command
		is "daps [X] -d DC-file pdf". Without this parameter,
		--force will be added automatically.

--no-gui	Don't start GUI when "compare" is finished. This flag
		will be set automatically if no Display is available.
		Without a display, rendering HTML is impossible.

--testcases=''	Sets the path to the folder containing the test cases.
		If none is set, the current working directory is 
		assumed.
		
--no-pdf	Do not build PDF files.

--no-html	Do not build HTML files. Use this parameter when you are
		not using an X Server which is required for rendering
		HTML.

--no-shtml	Do not build single HTML files. Use this parameter when
		you are not using an X Server which is required for
		rendering HTML.

--no-epub	Do not build EPUB files. *EPUB not available yet*

--html-width=x	Render HTML page with a width of x pixels. x can also be
		a list of comma separated values, i.e. 600,1280,1920

--load-config	Load config file of past runs. This option overrides all
		other file type and resolution options.

=== Version ===

Version: dapscompare 0.2.0

=== License ===

The MIT License (MIT)

Copyright (c) 2016,
Sven Seeberg-Elverfeldt <sseebergelverfeldt@suse.com>

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files 
(the "Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish, 
distribute, sublicense, and/or sell copies of the Software, and to 
permit persons to whom the Software is furnished to do so, subject to 
the following conditions:
 
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
