Merge pull request #3 from geekwright/sums259

Add some automation support

.gitignore

@@ -3,4 +3,4 @@
 \#*
 *.bak
 .idea/
-coverage.clover
+xoopswork/

README.md

@@ -1,3 +1,24 @@
 # xfilecheck
 
-**Work in Progress** File integrity checker for XOOPS 2.5
+## File integrity checker for XOOPS 2.5
+
+This script allows you to check that the XOOPS system files have been correctly uploaded to your server. It reads all the XOOPS files and reports missing or invalid ones.
+
+## Download
+
+- Visit the [xfilecheck Releases area on GitHub](https://github.com/XOOPS/xfilecheck/releases)
+- Locate the Checksum verification for XOOPS archive that matches your version of XOOPS
+- From the Assets section, choose the .zip or .tar.gz *source code* archive as appropriate to your system
+
+## Checking Files
+
+### Basic legacy method instructions
+- Upload the checksum.php script and checksum.md5 from the downloaded archive file to your XOOPS documents root
+- Access http://(yourxoopssite)/checksum.php using your browser
+- Correct any issues reported by re-uploading missing or invalid files
+- you should remove checksum.php and checksum.md5 after you have verified the files
+
+### Advanced command line usage
+- unarchive the xfilecheck archive on your server
+- invoke command using: *php checksum.php --root=/file/path/to/XoopsCore25/htdocs*
+- Correct any issues reported by re-uploading missing or invalid files

build

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+if [ "$1" != "" ]; then
+    rm -rf xoopswork
+    git clone --branch "$1" --depth 1 https://github.com/XOOPS/XoopsCore25.git xoopswork
+    php checksum.create.php --root=xoopswork/htdocs
+else
+    echo "Specify the release version tag"
+fi
+