danielsiepmann/website-comparison
1
0
Code Issues Pull requests Projects Releases Wiki Activity

TASK: Add readme

Browse source
This commit is contained in:
Daniel Siepmann 2018-10-23 14:43:17 +02:00
parent 09bdc7e73f
commit 2337b7d8e4
Signed by: Daniel Siepmann
GPG key ID: 33D6629915560EF4
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
readme.rst Normal file
View file

@ -0,0 +1,26 @@
Website Comparison
==================
A small command line tool that will screenshot a whole website. On the next run
there can be a comparison to the base that was created before.
Installation
------------
Run ``composer install``.
Also ``chromedriver`` is needed. Right now the pat his hardcoded to
``/usr/lib/chromium-browser/chromedriver`` in file ``comparison``.
Also the ``chromium-browser`` binary has to be inside the ``$PATH``.
Usage
-----
First run ``./comparison comparison:createbase`` to create the "base" version of the
website. This way we have the base to compare against later.
Second run ``./comparison comparison:comparetobase`` to screenshot website again and
inform about differences.
For further possible options add ``--help``.