Changes between Version 6 and Version 7 of NewParrotDeveloperGuide

Timestamp:

12/10/08 17:33:14 (13 years ago)

Author:

gaurav

Comment:

Monospaced program and path names, replaced some "your" -> "you're", other minor fixes

NewParrotDeveloperGuide

@@ -1 +1 @@
 == Newcomers Welcome! ==
 
-We're going to do our best to document the experiences of newcommers to Perl, Parrot and Open Source software development. Hopefully this will evolve into a road map for those who wish to contribute but are having trouble getting started.
+We're going to do our best to document the experiences of newcomers to Perl, Parrot and Open Source software development. Hopefully this will evolve into a road map for those who wish to contribute but are having trouble getting started.
 
 == Before you start ==
@@ -14 +14 @@
 == Getting Parrot ==
 
-If your going to become part of the development team, you'll need to check out a local copy of the source code. You can visit the  [http://www.parrotcode.org/source.html download] page on the main Parrot web site for full details. You'll need to make sure you have the following already installed on your machine.
+If your going to become part of the development team, you'll need to check out a local copy of the source code. You can visit the  [http://www.parrotcode.org/source.html download] page on the main Parrot web site for full details.
 
 Assuming you've got Perl, perldoc and Subversion installed you'll be doing something like this.
@@ -27 +27 @@
 }}}
 
-One make target to avoid right now is install. Running make install is not currently recommended.
+One make target to avoid right now is install. Running `make install` is not currently recommended.
 
 == Running Parrot ==
@@ -46 +46 @@
 == Learning Parrot ==
 
-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 [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 perldoc] 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.
+You've downloaded, configured, compiled, tested and created the html documentation for Parrot. Now it's time to start reading. Parrot's 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 in any HTML browser. 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 perldoc] to view the actual pod files, formatted as man pages. It cannot be stressed enough how important it is to read the documentation for this project.
 
 The bare minimum reading needed to get you off the ground is:
 
- * docs/info.pod
- * docs/gettingstarted.pod
+ * `docs/info.pod`
+ * `docs/gettingstarted.pod`
 
-After you read those, you'll want to run through all of the tutorials in examples/tutorial.
+After you read those, you'll want to run through all of the tutorials in `examples/tutorial`.
 
-Next on your reading list should be the PDDs (Parrot Design Documents). You will learn much by reading these, so don't skimp.
+Next on your reading list should be the PDDs (Parrot Design Documents) in `docs/ppds`. You will learn much by reading these, so don't skimp.
 
 == Contributing ==
 
-By now you've read the introductory documentation and reviewed the example/tutorial files. Now you have to decide what area of the project you'd like to contribute to.
+By now you've read the introductory documentation and reviewed the `example/tutorial` files. Now you have to decide what area of the project you'd like to contribute to.
 
 === Test Suite ===
 
-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. [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:
+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. [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 you're 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, mainly: `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 you're in the root build directory, you can run the following to view the module documentation:
 
 {{{
@@ -69 +69 @@
 }}}
 
-You already now that make test runs the test suite, but when working on individual tests you'll want to run only the test your concerned with. You can do this using Perls prove for a Perl test or either prove or Parrot itself for PIR tests.
+You already know that `make test` runs the test suite, but when working on individual tests you'll want to run only the test your concerned with. You can do this using Perl's [http://perldoc.perl.org/prove.html prove] for a Perl test, or either `prove` or Parrot itself for PIR tests.
 
 {{{
@@ -110 +110 @@
 [http://www.perlfoundation.org/parrot/index.cgi/names_test_rewrite.patch?action=attachments_download;page_name=starting_at_the_bottom;id=20081113142750-0-29058 names_test_rewrite.patch]
 
-Then you'll need to send an email, with the patch as an attachment, to Perlbug. It should look something like this.
+Then you'll need to send an email, with the patch as an attachment, to Parrotbug. It should look something like this.
 
 {{{