qi/README

   1                             +-------------+
   2                             | Qi's README |
   3                             +-------------+
   4
   5
   6   1. Introduction
   7   2. Installation
   8   3. Contact
   9
  10
  11   1. Introduction.
  12
  13 Qi is a simple but well-integrated package manager.  It can creates,
  14 install, remove, and upgrade software packages.  Qi produces binary
  15 packages using recipe names, these are files containing specific
  16 instructions to build every source.  Qi can manage multiple packages
  17 under a single directory hierarchy, this method allows to maintain a set
  18 of packages and multiple versions of them.  This means that Qi could be
  19 used as the main package manager or complement the existing one.
  20
  21    Qi offers a friendly command line interface, a global configuration
  22 file, a simple recipe layout to deploy software packages; also works
  23 with binary packages in parallel, speeding up installations and packages
  24 in production.  The used format for packages is a simplified but safe
  25 POSIX pax archive compressed with lzip.
  26
  27    Qi is a modern (POSIX-compliant) shell script released under the
  28 terms of the GNU General Public License.  There are only two major
  29 dependencies for the magic: graft(1) and tarlz(1), the rest is expected
  30 to be found in any Unix-like system.
  31
  32   2. Installation.
  33
  34 Requirements:
  35
  36 - A POSIX-compliant shell.
  37
  38 - Graft: http://peters.gormand.com.au/Home/tools
  39
  40     Perl (http://www.perl.org) is required in order to run graft(1).
  41
  42                                   Note
  43     Take into account when graft is installed, you can define some
  44     macros like PACKAGEDIR and TARGETDIR.  To be consistent use the
  45     same paths when `configure', adjusting it via --packagedir and
  46     --targetdir options.  If you have not changed the default values
  47     used on the graft installation, you can avoid these steps, since
  48     qi uses the same graft values for PACKAGEDIR and TARGETDIR.
  49
  50 - Tarlz: http://lzip.nongnu.org/tarlz.html
  51
  52 - A mktemp(1) implementation (normally included in the system):
  53   http://www.mktemp.org
  54
  55 To configure, make and install qi, type:
  56
  57   $ ./configure
  58   $ make
  59   $ make install
  60
  61 See `./configure --help' for more options.
  62
  63 To install in a different location, DESTDIR is supported.  This is useful
  64 for package distributors:
  65
  66   $ make DESTDIR=/tmp/qi install
  67
  68   3. Contact.
  69
  70   The Qi home page can be found at `http://www.dragora.org'.
  71 Send bug reports or suggestions to <dragora-users@nongnu.org>.