[svn:parrot] r36938 - in trunk: . docs/pct

jkeenan at svn.parrot.org jkeenan at svn.parrot.org
Mon Feb 23 12:01:17 UTC 2009


Author: jkeenan
Date: Mon Feb 23 12:01:17 2009
New Revision: 36938
URL: https://trac.parrot.org/parrot/changeset/36938

Log:
Applying documentation patch submitted by Andy Wardley in
http://rt.perl.org/rt3/Ticket/Display.html?id=63394.

Modified:
   trunk/CREDITS
   trunk/docs/pct/gettingstarted.pod

Modified: trunk/CREDITS
==============================================================================
--- trunk/CREDITS	Mon Feb 23 09:38:42 2009	(r36937)
+++ trunk/CREDITS	Mon Feb 23 12:01:17 2009	(r36938)
@@ -106,6 +106,11 @@
 E: andy at petdance.com
 U: petdance
 
+N: Andy Wardley
+E: abw at wardley.org
+W: http://wardley.org/
+D: Minor documentation fixes
+
 N: Angel Faus
 D: CFG and live analysis.
 

Modified: trunk/docs/pct/gettingstarted.pod
==============================================================================
--- trunk/docs/pct/gettingstarted.pod	Mon Feb 23 09:38:42 2009	(r36937)
+++ trunk/docs/pct/gettingstarted.pod	Mon Feb 23 12:01:17 2009	(r36938)
@@ -107,16 +107,12 @@
 
  $ perl tools/dev/mk_language_shell Foo languages/foo
 
-This will create a complete language that compiles out of the box, except for
-the fact that there's no Makefile yet. In order to resolve that, you should
-(re)run the Configure.pl script:
-
- $ perl Configure.pl
-
-This will regenerate all makefiles, including the one for your language. Now,
-in order to compile your language, type:
+This will create a complete language that compiles out of the box.  You first 
+need to run the C<Configure.PL> Perl script to generate the C<Makefile>.  Then
+you can run C<make> and C<make test>.
 
  $ cd languages/foo
+ $ perl Configure.pl
  $ make
  $ make test
 
@@ -126,6 +122,7 @@
 The generated directories and files have the following structure:
 
  foo/
+    /Configure.pl                # configuration script
     /config/makefiles/root.in    # input for the Makefile generator
                                  # as long as you don't add source files,
                                  # there's no need to update this file.
@@ -136,15 +133,23 @@
                /grammar-oper.pg  # file containing a default operator table.
 
         /builtins/
-                 /say.pir      # a file containing a built-in function
-                               # add more "standard library" routines here
-    /t/
-      /00-sanity.t             # a test file
-      /harness                 # file to set up the test framework
-                               # more tests can be added here
+                 /say.pir        # a file containing a built-in function
+
+        /pmc/
+                 /foo.pmc        # file defining vtable functions 
 
-    /foo.pir                   # file containing the main routine
-    /README                    # an almost empty readme file
+        /ops/
+                 /foo.ops        # file defining opcodes 
+                                 # TODO: add more "standard library" routines here
+    /t/
+      /00-sanity.t               # a test file
+      /harness                   # file to set up the test framework
+                                 # more tests can be added here
+
+    /foo.pir                     # file containing the main routine
+    /README                      # an almost empty readme file
+    /STATUS                      # an almost empty status file
+    /MAINTAINER                  # a file for you to add your details to
 
 
 When you want to run a script through your language's compiler, (assuming


More information about the parrot-commits mailing list