bootstrap: Use pipes by default to speed up the build process
[dragora.git] / qi / README
blob966a02ba719cf3577eac6ed60484629ae6454426
2 Qi is a simple but well-integrated package manager.  It can create,
3 install, remove, and upgrade software packages.  Qi produces binary
4 packages using recipes, which are files containing specific instructions
5 to build each package from source.  Qi can manage multiple packages
6 under a single directory hierarchy.  This method allows to maintain a
7 set of packages and multiple versions of them.  This means that Qi could
8 be used as the main package manager or complement the existing one.
10    Qi offers a friendly command line interface, a global configuration
11 file, a simple recipe layout to deploy software packages; also works
12 with binary packages in parallel, speeding up installations and packages
13 in production.  The format used for packages is a simplified but safe
14 POSIX pax archive compressed with lzip.
16    Qi is a modern (POSIX-compliant) shell script released under the
17 terms of the GNU General Public License.  There are only two major
18 dependencies for the magic: graft(1) and tarlz(1), the rest is expected
19 to be found in any Unix-like system.
21 == RUNTIME REQUIREMENTS
23 - A POSIX-compliant shell.
25 - Graft: http://peters.gormand.com.au/Home/tools
27 - Perl (http://www.perl.org) is required in order to run graft(1).
29                                   ~ Note ~
30     Take into account when graft is installed, you can define some
31     macros like PACKAGEDIR and TARGETDIR.  To be consistent use the
32     same paths when `configure', adjusting it via --packagedir and
33     --targetdir options.  If you have not changed the default values
34     used on the graft installation, you can avoid these steps, since
35     qi uses the same graft values for PACKAGEDIR and TARGETDIR.
37 - Tarlz to produce binary packages: http://lzip.nongnu.org/tarlz.html
39 == INSTALLATION
41 To configure, make and install qi, type:
43   $ ./configure
44   $ make
45   $ make install
47 See `./configure --help' for more options.
49 To install in a different location, DESTDIR is supported.  This is useful
50 for package distributors:
52   $ make DESTDIR=/tmp/qi install
54 == CONTACT
56   The Qi home page can be found at `https://www.dragora.org'.
57 Send bug reports or suggestions to <dragora-users@nongnu.org>.