Permalink
Browse files

Update the main repo 'README' to pod.

  • Loading branch information...
1 parent 97b7de5 commit a827f5dca985b11a9a2f4e007969e5abe3650bf7 @ayardley ayardley committed Apr 26, 2012
Showing with 149 additions and 0 deletions.
  1. +149 −0 README.pod
View
@@ -0,0 +1,149 @@
+# Copyright (C) 2001-2011, Parrot Foundation.
+
+=pod
+
+=head1 NAME
+
+README.pod - Readme to Parrot, version 3.10.0.
+
+=head1 DESCRIPTION
+
+Parrot is a virtual machine designed to, efficiently, compile and execute
+bytecode for dynamic languages.
+
+=head1 LICENSE
+
+This code is distributed under the terms of the Artistic License 2.0.
+For more details, see the full text of the license in the file 'LICENSE'.
+
+=head1 PREREQUISITES
+
+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.
+
+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.
+
+=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>):
+
+On Ubuntu/Debian (apt-based):
+
+ apt-get install git-core
+
+On Red Hat, Fedora (rpm-based):
+
+ yum install git
+
+on Gentoo (portage):
+
+ emerge -av dev-vcs/git
+
+Windows:
+There are 2 Git ports on Windows:
+
+ msysgit http://code.google.com/p/msysgit/downloads/list
+ 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,
+
+ http://help.github.com/mac-git-installation/
+
+=head2 II. Obtaining Parrot from github.com
+
+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":
+
+ 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:
+
+ 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
+
+ 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
+
+ perl Configure.pl --cc=cc --link=CC --ld=CC
+
+I<See> 'perl Configure.pl --help' for more options and 'docs/configuration.pod'
+for more details.
+
+For systems like HPUX that don't have inet_pton please run
+
+ perl Configure.pl --define=inet_aton
+
+Running 'Configure.pl' will generate a 'config.h' header, a 'Parrot::Config'
+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.)
+
+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.
+
+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:
+
+ 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.
+
+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'.
+
+=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/.
+
+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>.
+
+=head1 WEB SITES
+
+For more information on Parrot, I<see>
+
+ http://www.parrot.org/
+ http://docs.parrot.org/
+ http://parrot.github.com/
+
+Have fun,
+ The Parrot Team.
+
+=cut

0 comments on commit a827f5d

Please sign in to comment.