skopt - Some Kind Of Packaging Tool
Version 0.1.0, 21-Oct-18

Intro
-----

skopt is a command-line tool that's intended to be used for automating some aspects of preparing RiscPkg packages and indexes for distribution. There are two main functions that it provides:

* The ability to copy an arbitrarily-named package file to a destination folder, while also renaming it to a canonical form

* The ability to generate assorted types of repository / distribution metadata files, by scanning folder(s) containing packages


Usage
-----

skopt copy -d <dest> [-i <infile>] [<file> ...]
    Copy a list of packages to the given destination folder,
    renaming to canonical form and throwing an error if there
    are any packages with the same version but differing content.

skopt gen-binary-index -d <dest> <folder> <url> [...]
    Generate a RiscPkg binary index file at <dest>, based around
    the latest versions of all the packages in the indicated
    source folder(s), using the given (per-folder) URL prefixes.

skopt gen-pointer-file -d <dest> <folder> <url> [...]
    Generate a ROOL pointer file at <dest>, based around
    the latest versions of all the packages in the indicated
    source folder(s), using the given (per-folder) URL prefixes.


Note that the various "gen-" options only process files which have .zip extensions (i.e. /zip under RISC OS); RISC OS filetypes are ignored.


File lists
----------

The "-i" option for the copy command allows you to provide skopt with a file containing the list of files to copy. This should be a text file, with one filename per line. White space at the start and end of each line is ignored. Blank lines and lines starting with '#' are ignored.

It's possible to repeat the -i option as many times as desired.


Legal
-----

skopt is Copyright(c)2018, Jeffrey Lee
Allrightsreserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.


skopt is built ontop of LibPkg, https://github.com/alanbu/LibPkg

LibPkg is licensed under the terms of the GNU Lesser General Public License. See <skopt$Dir>.COPYING for details.


Contact
-------

You can email me@phlamethrower.co.uk, or visit my website:
http://www.phlamethrower.co.uk/

- Jeffrey Lee
