Skip to content

Commit

Permalink
Update doc to conform to supposed 78 character length.
Browse files Browse the repository at this point in the history
  • Loading branch information
ayardley committed Dec 18, 2011
1 parent 494eac3 commit 2f2764c
Showing 1 changed file with 49 additions and 19 deletions.
68 changes: 49 additions & 19 deletions README.pod
Expand Up @@ -20,18 +20,24 @@ For more details, see the full text of the license in the file 'LICENSE'.

You need a C compiler, a linker, and a 'make' program.

If you plan to link Parrot with the ICU library, you must download and install it I<before> configuring Parrot. You may obtain the ICU library at http://site.icu-project.org/download.
If you plan to link Parrot with the ICU library, you must download and install
it I<before> configuring Parrot. You may obtain the ICU library at
http://site.icu-project.org/download.

You will also need Perl 5.8.4 or newer and Storable 2.12 or newer in order to run various configure and build scripts.
You will also need Perl 5.8.4 or newer and Storable 2.12 or newer in order to
run various configure and build scripts.

For most of the platforms we support, Parrot should build out-of-the-box. 'docs/parrot.pod' lists the core platforms, and 'PLATFORMS' provides reports on the platforms on which Parrot has been built and tested.
For most of the platforms we support, Parrot should build out-of-the-box.
'docs/parrot.pod' lists the core platforms, and 'PLATFORMS' provides reports on
the platforms on which Parrot has been built and tested.

=head1 HOW TO GET PARROT FROM GITHUB

=head2 I. Install Git.

Linux:
The method depends on your distribution. To install you should execute (as root or sudo <cmd>):
The method depends on your distribution. To install you should execute (as root
or sudo <cmd>):

On Ubuntu/Debian (apt-based):

Expand All @@ -52,7 +58,8 @@ There are 2 Git ports on Windows:
TortoiseGit http://code.google.com/p/tortoisegit/downloads/list

Macintosh OS X:
An Internet search will locate a variety of git installers for Mac OS X, for example,
An Internet search will locate a variety of git installers for Mac OS X, for
example,

http://help.github.com/mac-git-installation/

Expand All @@ -62,23 +69,30 @@ To obtain a copy of the Parrot Git repository:

git clone git://github.com/parrot/parrot.git

This will checkout the master branch by default. To create a local branch which tracks the branch "some_branch":
This will checkout the master branch by default. To create a local branch which
tracks the branch "some_branch":

git checkout -b --track some_branch origin/some_branch

All the above URLs are read-only. If you are a Parrot core developer, then use the read-write URL:
All the above URLs are read-only. If you are a Parrot core developer, then use
the read-write URL:

git clone git@github.com:parrot/parrot.git

You can view the list of branches at http://github.com/parrot/parrot

=head1 INSTRUCTIONS

For now, unpack your Parrot tarball, (if you're reading this, you've probably already done that) and type
For now, unpack your Parrot tarball, (if you're reading this, you've probably
already done that) and type

perl Configure.pl --optimize

to run the Configure script. The 'Configure.pl' script extracts configuration information from the running perl5 program. You may need to explicitly tell 'Configure.pl' which compiler and linker to use. For example, to compile C files with 'cc', C++ files with 'CC', and link everything together with 'CC', you would type
to run the Configure script. The 'Configure.pl' script extracts configuration
information from the running perl5 program. You may need to explicitly tell
'Configure.pl' which compiler and linker to use. For example, to compile C
files with 'cc', C++ files with 'CC', and link everything together with 'CC',
you would type

perl Configure.pl --cc=cc --link=CC --ld=CC

Expand All @@ -94,46 +108,62 @@ module, platform files, and many Makefiles.

The file 'myconfig' has an overview of configure settings.

Next, run 'make'. ('Configure.pl' will tell you which version of 'make' it recommends for your system.)
Next, run 'make'. ('Configure.pl' will tell you which version of 'make' it
recommends for your system.)

Now, the interpreter should build. If you are building the ICU library (this is the default on most systems), you need to use 'GNU make' instead (or something compatible with it).
Now, the interpreter should build. If you are building the ICU library (this
is the default on most systems), you need to use 'GNU make' instead (or
something compatible with it).

You can test Parrot by running 'make test'. You can run the tests in parallel with 'make TEST_JOBS=3 test'.

You can run the full test suite with

make fulltest

NOTE: PLATFORMS contains notes about whether test failures are expected on your system.
NOTE: PLATFORMS contains notes about whether test failures are expected on your
system.

You can install Parrot with,

make install

By default, this installs in '/usr/local', with the Parrot executable in '/usr/local/bin'. If you want to install Parrot into another location use the following:
By default, this installs in '/usr/local', with the Parrot executable in
'/usr/local/bin'. If you want to install Parrot into another location use the
following:

perl Configure.pl --prefix=/dir/to/install/
make install

But please note, the dynamic libs will not be found for non-standard locations unless you set the enviornment variable 'LD_LIBRARY_PATH' or something similar.
But please note, the dynamic libs will not be found for non-standard locations
unless you set the enviornment variable 'LD_LIBRARY_PATH' or something similar.

For where to go from here, I<see> F<docs/parrot.pod> and I<see> F<docs/intro.pod>. If you experience problems, please I<see> the section "How To Submit A Bug Report" in F<docs/submissions.pod>. These documents are in POD format, and you can view them with the command,
For where to go from here, I<see> F<docs/parrot.pod> and I<see>
F<docs/intro.pod>. If you experience problems, please I<see> the section
"How To Submit A Bug Report" in F<docs/submissions.pod>. These documents are in
POD format, and you can view them with the command,

perldoc -F docs/intro.pod

=head1 CHANGES

For documentation on the user-visible changes between this and previous versions of Parrot, I<see> 'ChangeLog'.
For documentation on the user-visible changes between this and previous
versions of Parrot, I<see> 'ChangeLog'.

=head1 MAILING LISTS

The Parrot user mailing list is 'parrot-users@lists.parrot.org'. You may subscribe to the mailing list by filling out the form at http://lists.parrot.org/mailman/listinfo/parrot-users. There is an archive of the mailing list at http://lists.parrot.org/pipermail/parrot-users/.
The Parrot user mailing list is 'parrot-users@lists.parrot.org'. You may
subscribe to the mailing list by filling out the form at
http://lists.parrot.org/mailman/listinfo/parrot-users. There is an archive of
the mailing list at http://lists.parrot.org/pipermail/parrot-users/.

For development discussions, I<see> the information in F<docs/gettingstarted.pod>.
For development discussions, I<see> the information in
F<docs/gettingstarted.pod>.

=head1 FEEDBACK, PATCHES, etc.

For more information on how to report bugs and to submit patches, I<see> F<docs/submissions.pod>.
For more information on how to report bugs and to submit patches, I<see>
F<docs/submissions.pod>.

=head1 WEB SITES

Expand Down

0 comments on commit 2f2764c

Please sign in to comment.