README: sync with wiki
[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 <http://movial.fi/> and released under GPL 2 or
22 later.  Primary developer contact is Timo Savola <tsavola@movial.fi>.
23
24
25 Requirements
26 ============
27
28 * Scratchbox Apophis <http://scratchbox.org/>
29   - scratchbox-core
30   - scratchbox-libs
31   - scratchbox-devkit-git
32   - scratchbox-devkit-cputransp - optional
33
34 or
35
36 * POSIX environment (e.g. GNU/Linux)
37 * Python 2.3 <http://python.org/>
38 * Git 1.5 <http://git.or.cz/>
39 * GNU Make 3.80 <http://www.gnu.org/software/make/>
40 * Scratchbox 2 <http://freedesktop.org/wiki/Software/sbox2> - optional