diff --git a/README.md b/README.md index 5173a91..e0495d6 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,23 @@ # Snapraid Runner Script -This script runs snapraid, and sends it output to the console, a log file and +This script runs snapraid and sends its output to the console, a log file and via email. All this is configurable. It can be run manually, but its main purpose is to be run via cronjob/windows scheduler. +It supports Windows, Linux and macOS and runs on both python2 and python3. + ## How to use * If you don’t already have it, download and install - [the latest python 2.7](http://www.python.org/getit/). + [the latest python version](https://www.python.org/downloads/). * Download [the latest release](https://github.com/Chronial/snapraid-runner/releases) of this script and extract it anywhere or clone this repository via git. * Copy/rename the `snapraid-runner.conf.example` to `snapraid-runner.conf` and edit its contents. You need to at least configure `snapraid.exectable` and `snapraid.config`. -* Run the script via `python snapraid-runner.py`. +* Run the script via `python3 snapraid-runner.py` on Linux or + `py -3 snapraid-runner.py` on Windows. ## Features * Runs `diff` before `sync` to see how many files were deleted and aborts if @@ -24,7 +27,8 @@ scheduler. * Can run `scrub` after `sync` ## Changelog -### Unreleased +### v0.4 (17 Aug 2019) +* Add compatibility with python3 (by reed-jones) * Add support for running `snapraid touch` (by ShoGinn, PR-11) * Add SMTP TLS support