recipes: tools/ntfs-3g: Rename helper mount to be invoked by udevil
[dragora.git] / qi / README.md
blob8b81388c307c6a09a4c9f7f117624321dfde952f
1 Qi
2 ==
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.
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.
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.
23 Requirements
24 ------------
26 - A POSIX-compliant shell.
28 - Graft for handling symlinks: https://peters.gormand.com.au/Home/tools
29   Alternatively from https://rsync.dragora.org/current/sources/
31 - Perl in order to run Graft: https://www.perl.org
33 - Tarlz for produce binary packages: https://lzip.nongnu.org/tarlz.html
35 ### Note
37 Take into account when you are going to install graft, you can define some
38 macros like PACKAGEDIR and TARGETDIR.  To be consistent, please use the
39 same paths when `configure` adjusting them through the --packagedir and
40 --targetdir options.
42 If you have not changed the default values used on the graft installation,
43 you can avoid these steps, since qi uses the same values of graft for
44 PACKAGEDIR and TARGETDIR.
46 Installation
47 ------------
49 To configure, make and install qi, type:
51     $ ./configure
52     $ make
53     $ make install
55 See `./configure --help` for more options.
57 To install qi in a different location, type:
59     $ make DESTDIR=/tmp/qi install
61 This is useful for package distributors.
63 Contact
64 -------
66   The Qi home page can be found at https://www.dragora.org.
67 Send bug reports or suggestions to <dragora-users@nongnu.org>.