increase the version number of Dragora
[dragora.git] / qi / README
blobe6e3fc2fd98c66aa4dcfaf81ac5ec095a8eae6ad
1                             +-------------+
2                             | Qi's README |
3                             +-------------+
6   1. Introduction
7   2. Installation
8   3. Contact
11   1. Introduction.
13 Qi is a source builder and a package manager:
15    It contains a set of (individual) tools to build, install, remove,
16 and upgrade software packages.  It follows the philosophy of simplicity
17 without adding too many features, such as those that can be found in
18 popular package managers.  Basically it does two things: builds
19 packages and manages them.
21    Qi constructs the sources using recipe names, files that contain
22 specific instructions to build every source.  As result, a binary
23 package is obtained which can be installed, removed, upgraded, or
24 inspected in the system.
26    The packages are managed thanks to an external tool called
27 _graft(1)_, which provides a mechanism for managing multiple packages
28 under a single directory hierarchy, it was inspired by both Depot
29 (Carnegie Mellon University) and Stow (Bob Glickstein).  In this
30 aspect, Qi complements Graft: it can work with packages, check them,
31 solve conflicts, and more...
33   2. Installation.
35 Requirements:
37 - A (POSIX) compatible shell.
39 - Graft: http://peters.gormand.com.au/Home/tools
41     Perl (http://www.perl.org) is required in order to run graft(1).
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'.
47 - Lzip: http://lzip.nongnu.org
49 - A mktemp(1) implementation: http://www.mktemp.org
51 To configure, make and install qi, type:
53   $ ./configure
54   $ make
55   $ make install
57 See `./configure --help' for more information.
59 To install in a different location, DESTDIR is supported.  This is
60 useful for package distributors:
62   $ make DESTDIR=/tmp/qi install
64   3. Contact.
66   The Qi home page can be found at `http://www.dragora.org'.
67 Send bug reports or suggestions to <dragora-users@nongnu.org>.