Changes between Version 1 and Version 2 of NewParrotDeveloperGuide

Show
Ignore:
Timestamp:
12/10/08 06:27:38 (6 years ago)
Author:
leto
Comment:

fix some links

Legend:

Unmodified
Added
Removed
Modified
  • NewParrotDeveloperGuide

    v1 v2  
    4646== Learning Parrot == 
    4747 
    48 You've downloaded, configured, compiled, tested and created the html documentation for Parrot. Now it's time to start reading. Parrots source documentation is stored in "POD"<http://en.wikipedia.org/wiki/Plain_Old_Documentation> format. If you ran make html you can the view the documentation as html. The file docs/html/index.html is the place to start. An alternative and more flexible method for viewing the documentation is to use "perldoc"<http://search.cpan.org/dist/Pod-Perldoc/lib/perldoc.pod> to view the actual pod files. Perldoc will allow you to view the pod files formated as man pages. It cannot be stressed enough how important it is to read the documentation for this project. 
     48You've downloaded, configured, compiled, tested and created the html documentation for Parrot. Now it's time to start reading. Parrots source documentation is stored in [http://en.wikipedia.org/wiki/Plain_Old_Documentation POD] format. If you ran make html you can the view the documentation as html. The file docs/html/index.html is the place to start. An alternative and more flexible method for viewing the documentation is to use [http://search.cpan.org/dist/Pod-Perldoc/lib/perldoc.pod perl-doc] to view the actual pod files. Perldoc will allow you to view the pod files formated as man pages. It cannot be stressed enough how important it is to read the documentation for this project. 
    4949 
    5050The bare minimum reading needed to get you off the ground is: 
     
    6363=== Test Suite === 
    6464 
    65 Original Parrot tests where written in Perl. Those Perl tests can be ported to PIR test. This is a good place to earn your feathers and learn more PIR at the same time. "Converting existing tests to Parrot"<http://www.perlfoundation.org/parrot/index.cgi?convert_existing_tests_to_parrot> covers what you'll need to know about the format of a PIR test. If your not familiar with the test suite functions you'll want to review parrot/runtime/library/Test/More.pir. The functions section gives a description of the different testing functions like: plan, diag, ok, nok, is, is_deeply, like, isa_ok, skip, isnt and todo. This is a good time to point out that POD can and usually is embedded in PIR files. So if your in the root build directory you can run the following to view the module documentation: 
     65Original Parrot tests where written in Perl. Those Perl tests can be ported to PIR test. This is a good place to earn your feathers and learn more PIR at the same time. [http://www.perlfoundation.org/parrot/index.cgi?convert_existing_tests_to_parrot Converting existing tests to Parrot] covers what you'll need to know about the format of a PIR test. If your not familiar with the test suite functions you'll want to review parrot/runtime/library/Test/More.pir. The functions section gives a description of the different testing functions like: plan, diag, ok, nok, is, is_deeply, like, isa_ok, skip, isnt and todo. This is a good time to point out that POD can and usually is embedded in PIR files. So if your in the root build directory you can run the following to view the module documentation: 
    6666 
    6767{{{