Skip to content
Snippets Groups Projects
Commit e422d01a authored by Gabriel Mazetto's avatar Gabriel Mazetto
Browse files

Fix `.pod` specs

parent a3e03072
No related branches found
No related tags found
1 merge request!1GitLab-CI support
Loading
Loading
@@ -12,7 +12,7 @@ Primary goals are:
 
=over 4
 
=item* Create a working compiler that understands the majority of the
=item * Create a working compiler that understands the majority of the
MATLAB/Octave programming language.
 
=back
Loading
Loading
@@ -23,14 +23,14 @@ This project is broken into three primary components:
 
=over 4
 
=item* The first is the parser, located in the C<src/parser/> directory. The
=item * The first is the parser, located in the C<src/parser/> directory. The
parser proper is composed of three source files, F<grammar.pg> which is a
Perl6Grammar file, and F<actions.pm> which is the associated actions file
written in NQP, and F<grammar-oper.pm> which is the operator precidence parser.
In addition, several helper functions used by the parser are located in
C<src/internals>.
 
=item* The second component is the library of builtin functions in the
=item * The second component is the library of builtin functions in the
C<src/builtins/> directory. These functions are, currently, written primarily in
PIR. Function names prefixed with an underscore are "private" functions for use
with the parser. Other functions should have names which are the same as names
Loading
Loading
@@ -38,7 +38,7 @@ for regular MATLAB or Octave functions, since they will be available to the
HLL. These are also separated into different namespaces depending on visibility
and utility.
 
=item* A number of library functions are written in M, or mostly M with some
=item * A number of library functions are written in M, or mostly M with some
inline PIR code in C<toolbox/>.
 
=back
Loading
Loading
@@ -86,4 +86,3 @@ Lots!
If you need to contact the Matrixy team, go to the project home page at:
 
www.github.com\Whiteknight\matrixy
<a name="___top"></a>
 
<h1><a href="#___top" title="click to go to top of document" name="Matrixy">Matrixy</a></h1>
<h1><a name="Matrixy">Matrixy</a></h1>
 
<h2><a href="#___top" title="click to go to top of document" name="INTRODUCTION">INTRODUCTION</a></h2>
<h2><a name="INTRODUCTION">INTRODUCTION</a></h2>
 
<p>This is a port of the MATLAB/Octave programming language to Parrot.
See the ROADMAP file for more information on the status of this project,
and what else needs to be done.</p>
 
<h2><a href="#___top" title="click to go to top of document" name="ABOUT">ABOUT</a></h2>
<h2><a name="ABOUT">ABOUT</a></h2>
 
<p>Primary goals are:</p>
 
<blockquote>
<p>=item* Create a working compiler that understands the majority of the MATLAB/Octave programming language.</p>
</blockquote>
<ul>
<li>Create a working compiler that understands the majority of the MATLAB/Octave programming language.</li>
</ul>
 
<h2><a href="#___top" title="click to go to top of document" name="IMPLEMENTATION">IMPLEMENTATION</a></h2>
<h2><a name="IMPLEMENTATION">IMPLEMENTATION</a></h2>
 
<p>This project is broken into three primary components:</p>
 
<blockquote>
<p>=item* The first is the parser,
<ul>
<li>The first is the parser,
located in the <code>src/parser/</code> directory.
The parser proper is composed of three source files,
<em>grammar.pg</em> which is a Perl6Grammar file,
and <em>actions.pm</em> which is the associated actions file written in NQP,
and <em>grammar-oper.pm</em> which is the operator precidence parser.
In addition,
several helper functions used by the parser are located in <code>src/internals</code>.</p>
several helper functions used by the parser are located in <code>src/internals</code>.</li>
 
<p>=item* The second component is the library of builtin functions in the <code>src/builtins/</code> directory.
<li>The second component is the library of builtin functions in the <code>src/builtins/</code> directory.
These functions are,
currently,
written primarily in PIR.
Function names prefixed with an underscore are "private" functions for use with the parser.
Other functions should have names which are the same as names for regular MATLAB or Octave functions,
since they will be available to the HLL.
These are also separated into different namespaces depending on visibility and utility.</p>
These are also separated into different namespaces depending on visibility and utility.</li>
 
<p>=item* A number of library functions are written in M,
or mostly M with some inline PIR code in <code>toolbox/</code>.</p>
</blockquote>
<li>A number of library functions are written in M,
or mostly M with some inline PIR code in <code>toolbox/</code>.</li>
</ul>
 
<h2><a href="#___top" title="click to go to top of document" name="DEPENDENCIES">DEPENDENCIES</a></h2>
<h2><a name="DEPENDENCIES">DEPENDENCIES</a></h2>
 
<p>Matrixy depends on these dependencies:</p>
 
<h3><a href="#___top" title="click to go to top of document" name="Parrot">Parrot</a></h3>
<h3><a name="Parrot">Parrot</a></h3>
 
<p>To get a proper version of Parrot to build Matrixy,
you will need to check out and build Parrot from source:</p>
Loading
Loading
@@ -57,29 +57,29 @@ you will need to check out and build Parrot from source:</p>
perl Configure.pl
make &amp;&amp; make test &amp;&amp; make install-dev</pre>
 
<h3><a href="#___top" title="click to go to top of document" name="Parrot-Linear-Algebra">Parrot-Linear-Algebra</a></h3>
<h3><a name="Parrot-Linear-Algebra">Parrot-Linear-Algebra</a></h3>
 
<p>The linear algebra package for Parrot is available separately and provides functionality required by Matrixy. This includes matrix data types and matrix manipulation libraries</p>
 
<h2><a href="#___top" title="click to go to top of document" name="BUILDING">BUILDING</a></h2>
<h2><a name="BUILDING">BUILDING</a></h2>
 
<p>Once all dependencies are in place, you can build Matrixy using this sequence of commands:</p>
 
<pre> perl Configure.pl
nmake test</pre>
 
<h2><a href="#___top" title="click to go to top of document" name="TODO">TODO</a></h2>
<h2><a name="TODO">TODO</a></h2>
 
<pre> * Parser
* Standard Builtins
* Test against Octave Test Suite.</pre>
 
<h2><a href="#___top" title="click to go to top of document" name="BUGS">BUGS</a></h2>
<h2><a name="BUGS">BUGS</a></h2>
 
<p>Lots!</p>
 
<h2><a href="#___top" title="click to go to top of document" name="CONTACT">CONTACT</a></h2>
<h2><a name="CONTACT">CONTACT</a></h2>
 
<p>If you need to contact the Matrixy team, go to the project home page at:</p>
 
<p>www.github.com\Whiteknight\matrixy</p>
\ No newline at end of file
<p>www.github.com\Whiteknight\matrixy</p>
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment