make the rank fixup recursive
[matrix.git] / README
1 About
2 =====
3
4 Matrix is a tool for managing source code packages (or "components") and
5 controlling their building and installation.  The packages can either form a
6 complete operating system or just an application suite or such.  Other similar
7 tools include BitBake (OpenEmbedded), GAR/GARNOME and the ports mechanisms used
8 by BSD systems and source-based Linux distributions.
9
10 Matrix uses the Git version control system for managing the components and
11 their meta data.  Component development/maintenance is coupled with system
12 integration, which simplifies workflows.  Making a change to a component and
13 rebuilding the complete system is easy.  Upgrading to new upstream versions or
14 integrating fixes is convenient (even if the upstream project doesn't use Git).
15
16 Matrix is intended to be used with Scratchbox 1 or Scratchbox 2.  Matrix relies
17 on Scratchbox for cross-compilation and sandboxing; if you don't need either
18 (e.g. you want to install applications to your host system), you can use Matrix
19 without Scratchbox.
20
21 Matrix was developed by Movial Creative Technologies Inc. <http://movial.com/>
22 and released under GPL 2 or later.  Matrix-related topics may be discussed
23 on the #alip IRC channel in the Freenode network <http://www.freenode.net/>.
24
25
26 Requirements
27 ============
28
29 * Scratchbox Apophis <http://scratchbox.org/>
30   - scratchbox-core
31   - scratchbox-libs
32   - scratchbox-devkit-git
33   - scratchbox-devkit-mtd - optional (required for matrix-rootfs)
34   - scratchbox-devkit-cputransp - optional
35
36 or
37
38 * POSIX environment (e.g. GNU/Linux)
39 * Python 2.3 <http://python.org/>
40 * Git 1.5 <http://git.or.cz/>
41 * GNU Make 3.80 <http://www.gnu.org/software/make/>
42 * Scratchbox 2 <http://freedesktop.org/wiki/Software/sbox2> - optional