AutoArchive installation instructions
=====================================


To install latest version of AutoArchive from online package repository run:
'pip install autoarchive'.

To install AutoArchive from a local copy of the distribution package run:
'pip install <path_to_distribution_package>'.



Dependencies
------------

As AutoArchive is written in Python language, it requires a Python interpreter.

Optional but recommended is GNU tar and compression programs that can be used
with GNU tar, namely gzip, bzip2, xz, etc.


Windows
.......

Windows includes BSD tar that is not compatible with AutoArchive.  To use
AutoArchive with external tar on Windows, you will need to install GNU tar.
A prebuilt binary from the MinGW project is a good option.  Ensure that PATH
environment variable is updated to point to the GNU tar executable.  Without
GNU tar, AutoArchive's internal tar support can still be used.
