documentation
[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 http://git.or.cz/[Git] version control system for managing the
11 components and their meta data.  Component development/maintenance is coupled
12 with system integration, which simplifies workflows.  Making a change to a
13 component and rebuilding the complete system is easy.  Upgrading to new
14 upstream versions or integrating fixes is convenient (even if the upstream
15 project doesn't use Git).
16
17 Matrix is intended to be used with http://scratchbox.org/[Scratchbox].
18 (Support for http://freedesktop.org/wiki/Software/sbox2[Scratchbox 2] is still
19 preliminary, but it is intended to be the primarily supported version in the
20 future.)  Matrix relies on Scratchbox for cross-compilation and sandboxing; if
21 you don't need either (e.g. you want to install applications to your host
22 system), you can use Matrix without Scratchbox.
23
24 Matrix was developed by http://movial.fi/[Movial] and released under GPL 2 or
25 later.  Primary developer contact is Timo Savola <mailto:tsavola@movial.fi[]>.
26
27
28 Requirements
29 ------------
30
31 - Scratchbox 1.0 <http://scratchbox.org/[]>
32 - Matrix devkit for Scratchbox
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/[]>