qi: doc: minor changes
[dragora.git] / qi / README
blob95f435ecb6d13a30f04d7c1e133c1a869bdf31ed
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-compliant 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                                   Note
44     Take into account when graft is installed, you can define some
45     macros like PACKAGEDIR and TARGETDIR.  To be consistent use the
46     same paths when `configure', adjusting it via --packagedir and
47     --targetdir options.  If you have not changed the default values
48     used on the graft installation, you can avoid these steps, since
49     Qi uses the same values for PACKAGEDIR and TARGETDIR of graft.
51 - Tarlz: http://lzip.nongnu.org/tarlz.html
53 - A mktemp(1) implementation (normally included on your system):
54   http://www.mktemp.org
56 To configure, make and install qi, type:
58   $ ./configure
59   $ make
60   $ make install
62 See `./configure --help' for more options.
64 To install in a different location, DESTDIR is supported.  This is
65 useful for package distributors:
67   $ make DESTDIR=/tmp/qi install
69   3. Contact.
71   The Qi home page can be found at `http://www.dragora.org'.
72 Send bug reports or suggestions to <dragora-users@nongnu.org>.