1=head1 Matrixy
 2
 3=head2 INTRODUCTION
 4
 5This is a port of the MATLAB/Octave programming language to Parrot. See the
 6ROADMAP file for more information on the status of this project, and what else
 7needs to be done.
 8
 9=head2 ABOUT
10
11Primary goals are:
12
13=over 4
14
15=item* Create a working compiler that understands the majority of the
16MATLAB/Octave programming language.
17
18=back
19
20=head2 IMPLEMENTATION
21
22This project is broken into three primary components:
23
24=over 4
25
26=item* The first is the parser, located in the C<src/parser/> directory. The
27parser proper is composed of three source files, F<grammar.pg> which is a
28Perl6Grammar file, and F<actions.pm> which is the associated actions file
29written in NQP, and F<grammar-oper.pm> which is the operator precidence parser.
30In addition, several helper functions used by the parser are located in
31C<src/internals>.
32
33=item* The second component is the library of builtin functions in the
34C<src/builtins/> directory. These functions are, currently, written primarily in
35PIR. Function names prefixed with an underscore are "private" functions for use
36with the parser. Other functions should have names which are the same as names
37for regular MATLAB or Octave functions, since they will be available to the
38HLL. These are also separated into different namespaces depending on visibility
39and utility.
40
41=item* A number of library functions are written in M, or mostly M with some
42inline PIR code in C<toolbox/>.
43
44=back
45
46=head2 DEPENDENCIES
47
48Matrixy depends on these dependencies:
49
50=head3 Parrot
51
52To get a proper version of Parrot to build Matrixy, you will need to check out
53and build Parrot from source:
54
55    svn co http://svn.parrot.org/parrot/trunk parrot
56    cd parrot
57    perl Configure.pl
58    make && make test && make install-dev
59
60=head3 Parrot-Linear-Algebra
61
62The linear algebra package for Parrot is available separately and provides
63functionality required by Matrixy. This includes matrix data types and matrix
64manipulation libraries
65
66=head2 BUILDING
67
68Once all dependencies are in place, you can build Matrixy using this sequence of
69commands:
70
71    perl Configure.pl
72    nmake test
73
74=head2 TODO
75
76    * Parser
77    * Standard Builtins
78    * Test against Octave Test Suite.
79
80=head2 BUGS
81
82Lots!
83
84=head2 CONTACT
85
86If you need to contact the Matrixy team, go to the project home page at:
87
88www.github.com\Whiteknight\matrixy
89