From 2337b7d8e415a169979e325043f704525b4689f7 Mon Sep 17 00:00:00 2001 From: Daniel Siepmann Date: Tue, 23 Oct 2018 14:43:17 +0200 Subject: [PATCH] TASK: Add readme --- readme.rst | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 readme.rst diff --git a/readme.rst b/readme.rst new file mode 100644 index 0000000..e99b6f8 --- /dev/null +++ b/readme.rst @@ -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``.