qi/README.md

   1 Qi
   2 ==
   3
   4 Qi is a simple but well-integrated package manager.  It can create,
   5 install, remove, and upgrade software packages.  Qi produces binary
   6 packages using recipes, which are files containing specific instructions
   7 to build each package from source.  Qi can manage multiple packages
   8 under a single directory hierarchy.  This method allows to maintain a
   9 set of packages and multiple versions of them.  This means that Qi could
  10 be used as the main package manager or complement the existing one.
  11
  12    Qi offers a friendly command line interface, a global configuration
  13 file, a simple recipe layout to deploy software packages; also works
  14 with binary packages in parallel, speeding up installations and packages
  15 in production.  The format used for packages is a simplified and safer
  16 variant of POSIX pax archive compressed in lzip format.
  17
  18    Qi is a modern (POSIX-compliant) shell script released under the
  19 terms of the GNU General Public License.  There are only two major
  20 dependencies for the magic: graft(1) and tarlz(1), the rest is expected
  21 to be found in any Unix-like system.
  22
  23 Requirements
  24 ------------
  25
  26 - A POSIX-compliant shell.
  27
  28 - Graft for handling symlinks: https://peters.gormand.com.au/Home/tools
  29   Alternatively from https://rsync.dragora.org/current/sources/
  30
  31 - Perl in order to run Graft: https://www.perl.org
  32
  33 - Tarlz for produce binary packages: https://lzip.nongnu.org/tarlz.html
  34
  35 Optional but highly recommended dependencies (at run-time) are:
  36
  37 - ed(1), tar(1), unzip(1), gzip(1), bzip2(1), lzip(1), xz(1).
  38
  39 These recommended dependencies are to support the testing and
  40 unpacking of tarballs, as well as compressed files in these formats.
  41
  42 Other system utilities that are checked and expected by Qi are:
  43
  44 - awk(1), basename(1), chmod(1), cp(1), dirname(1), find(1), fold(1),
  45   grep(1), mkdir(1), mktemp(1), rm(1), rmdir(1), sed(1), sha256sum(1),
  46   stat(1).
  47
  48 ### Note
  49
  50 Take into account when you are going to install graft, you can define some
  51 macros like PACKAGEDIR and TARGETDIR.  To be consistent, please use the
  52 same paths when `configure` adjusting them through the --packagedir and
  53 --targetdir options.
  54
  55 If you have not changed the default values used on the graft installation,
  56 you can avoid these steps, since qi uses the same values of graft for
  57 PACKAGEDIR and TARGETDIR.
  58
  59 Installation
  60 ------------
  61
  62 To configure, make and install qi, type:
  63
  64     $ ./configure
  65     $ make
  66     $ make install
  67
  68 See `./configure --help` for more options.
  69
  70 To install qi in a different location, type:
  71
  72     $ make DESTDIR=/tmp/qi install
  73
  74 This is useful for package distributors.
  75
  76 Contact
  77 -------
  78
  79   The Qi home page can be found at https://www.dragora.org.
  80 Send bug reports or suggestions to <dragora-users@nongnu.org>.