xbps/doc/README

-----------------------------------------------------------------------------
 WHAT IS IT?
-----------------------------------------------------------------------------

xbps - xtraeme's binary package ystem.

xbps is a new binary package system, taken ideas from other free available
implementations, such as dpkg/apt, RPM, pacman and others. Metadata handling
as package databases are handled by proplib. Multiple compression formats
are supported in binary packages thanks to libarchive.

xbps has been designed for Linux, and for the moment I'm not interested to
make it work on any other random OS. xbps is the base to create a basic
Linux system.

-----------------------------------------------------------------------------
 REQUIREMENTS
-----------------------------------------------------------------------------

xbps uses proplib, a property container object library and it's almost the
same one available for NetBSD. Be sure to have it installed before using
xbps. You can get it at:

http://code.google.com/p/portableproplib/

I'm also the human maintaining the portable proplib package. I'd suggest you
to install it into /usr/local to avoid issues with your distribution packages.

Additionally the following software is required in the host system to build
and install xbps binary packages:

	* GNU GCC C++
	* GNU Make
	* GNU Bison
	* fakeroot
	* wget OR curl OR fetch
	* libarchive (devel package with static library. 
	  acl, lzma, bzip2 support)
	* libacl (devel package with static library)
	* lzma/xz (devel package with static library)
	* bzip2 (devel package with static library)
	* perl
	* sudo

Super-user privileges are required as well, because all packages are built
in a chroot (except the ones that are included in a virtual package to be
able to build a minimal system for the chroot).

PLEASE NOTE THAT fakechroot or fakeroot-ng DO NOT WORK.

------------------------------------------------------------------------------
 HOW TO USE IT
------------------------------------------------------------------------------

Before using xbps, some required utilities need to be built and installed
into $(PREFIX); by default they are installed into /usr/local.
You can do this by issuing "make" and "make install" as root in the top
level directory. See the REQUIREMENTS section above for required packages.

Once the xbps distfiles are installed into prefix, you can start building
packages from source, add local repositories with binary packages, install or
remove them, etc.

If you are only interested in building/using packages from source, see the
SRCPKG_INFO file.

For information about binary packages, see the BINPKG_INFO file.

------------------------------------------------------------------------------
	Juan Romero Pardines <xtraeme@gmail.com>