all repos — markup @ 24dbb97bf22ff68c4cc0597f05efb258c0d1860c

The code we use to render README.your_favorite_markup

fix pod test
Chris Wanstrath chris@ozmm.org
Tue, 09 Feb 2010 12:47:33 -0800
commit

24dbb97bf22ff68c4cc0597f05efb258c0d1860c

parent

c50ba283985f4d08b6137a2a697658d0377fd0a6

1 files changed, 85 insertions(+), 95 deletions(-)

jump to
M test/markups/README.pod.htmltest/markups/README.pod.html

@@ -1,118 +1,108 @@

+<a name='___top' class='dummyTopAnchor' ></a> -<div name="index"> -<p><a name="__index__"></a></p> +<h1><a class='u' href='#___top' title='click to go to top of document' +name="Matrixy" +>Matrixy</a></h1> -<ul> +<h2><a class='u' href='#___top' title='click to go to top of document' +name="INTRODUCTION" +>INTRODUCTION</a></h2> - <li><a href="#matrixy">Matrixy</a></li> - <ul> +<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> - <li><a href="#introduction">INTRODUCTION</a></li> - <li><a href="#about">ABOUT</a></li> - <li><a href="#implementation">IMPLEMENTATION</a></li> - <li><a href="#dependencies">DEPENDENCIES</a></li> - <ul> +<h2><a class='u' href='#___top' title='click to go to top of document' +name="ABOUT" +>ABOUT</a></h2> - <li><a href="#parrot">Parrot</a></li> - <li><a href="#parrot_linear_algebra">Parrot-Linear-Algebra</a></li> - </ul> +<p>Primary goals are:</p> - <li><a href="#building">BUILDING</a></li> - <li><a href="#todo">TODO</a></li> - <li><a href="#bugs">BUGS</a></li> - <li><a href="#contact">CONTACT</a></li> - </ul> - -</ul> +<blockquote> +<p>=item* Create a working compiler that understands the majority of the MATLAB/Octave programming language.</p> +</blockquote> -<hr name="index" /> -</div> +<h2><a class='u' href='#___top' title='click to go to top of document' +name="IMPLEMENTATION" +>IMPLEMENTATION</a></h2> +<p>This project is broken into three primary components:</p> -<p> -</p> -<h1><a name="matrixy">Matrixy</a></h1> -<p> -</p> -<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> -<p> -</p> -<h2><a name="about">ABOUT</a></h2> -<p>Primary goals are:</p> -<ul> -<li><strong><a name="create_a_working_compiler_that_understands_the_majority_of_the_matlab_octave_programming_language" class="item">Create a working compiler that understands the majority of the -MATLAB/Octave programming language.</a></strong> +<blockquote> +<p>=item* 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> -</ul> -<p> -</p> -<h2><a name="implementation">IMPLEMENTATION</a></h2> -<p>This project is broken into three primary components:</p> -<ul> -<li><strong><a name="the_first_is_the_parser_located_in_the_src_parser_directory_the_parser_proper_is_composed_of_three_source_files_grammar_pg_which_is_a_perl6grammar_file_and_actions_pm_which_is_the_associated_actions_file_written_in_nqp_and_grammar_oper_pm_which_is_the_operator_precidence_parser_in_addition_several_helper_functions_used_by_the_parser_are_located_in_src_internals" class="item">The first is the parser, located in the <code>src/parser/</code> directory. The -parser proper is composed of three source files, <em class="file">grammar.pg</em> which is a -Perl6Grammar file, and <em class="file">actions.pm</em> which is the associated actions file -written in NQP, and <em class="file">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>.</a></strong> +<p>=item* 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 &#34;private&#34; 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> -<li><strong><a name="the_second_component_is_the_library_of_builtin_functions_in_the_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_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" class="item">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 &quot;private&quot; 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.</a></strong> +<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><strong><a name="a_number_of_library_functions_are_written_in_m_or_mostly_m_with_some_inline_pir_code_in_toolbox" class="item">A number of library functions are written in M, or mostly M with some -inline PIR code in <code>toolbox/</code>.</a></strong> +<h2><a class='u' href='#___top' title='click to go to top of document' +name="DEPENDENCIES" +>DEPENDENCIES</a></h2> -</ul> -<p> -</p> -<h2><a name="dependencies">DEPENDENCIES</a></h2> <p>Matrixy depends on these dependencies:</p> -<p> -</p> -<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> -<pre> - svn co <a href="http://svn.parrot.org/parrot/trunk">http://svn.parrot.org/parrot/trunk</a> parrot + +<h3><a class='u' href='#___top' title='click to go to top of document' +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> + +<pre> svn co http://svn.parrot.org/parrot/trunk parrot cd parrot perl Configure.pl - make &amp;&amp; make test &amp;&amp; make install-dev</pre> -<p> -</p> -<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> -<p> -</p> -<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 + make &#38;&#38; make test &#38;&#38; make install-dev</pre> + +<h3><a class='u' href='#___top' title='click to go to top of document' +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 class='u' href='#___top' title='click to go to top of document' +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> -<p> -</p> -<h2><a name="todo">TODO</a></h2> -<pre> - * Parser + +<h2><a class='u' href='#___top' title='click to go to top of document' +name="TODO" +>TODO</a></h2> + +<pre> * Parser * Standard Builtins * Test against Octave Test Suite.</pre> -<p> -</p> -<h2><a name="bugs">BUGS</a></h2> + +<h2><a class='u' href='#___top' title='click to go to top of document' +name="BUGS" +>BUGS</a></h2> + <p>Lots!</p> -<p> -</p> -<h2><a name="contact">CONTACT</a></h2> + +<h2><a class='u' href='#___top' title='click to go to top of document' +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>