README

   1 This is Parrot, version 2.2.0
   2 ------------------------------
   3
   4 Parrot is Copyright (C) 2001-2010, Parrot Foundation.
   5
   6 $Id$
   7
   8 LICENSE INFORMATION
   9 -------------------
  10
  11 This code is distributed under the terms of the Artistic License 2.0.
  12 For more details, see the full text of the license in the file LICENSE.
  13
  14 PREREQUISITES
  15 -------------
  16
  17 You need a C compiler, a linker, and a make program of course.
  18
  19 If you will be linking with the ICU library you have to download and install it
  20 before configuring Parrot. Get it from http://site.icu-project.org/download
  21
  22 You also need Perl 5.8.4 or newer, and Storable 2.12 or newer
  23 for running various configure and build scripts.
  24
  25 For most of the platforms that we are supporting initially, Parrot should build
  26 out of the box. docs/parrot.pod lists the core platforms. PLATFORMS provides
  27 reports on the platforms on which Parrot has been built and tested.
  28
  29 INSTRUCTIONS
  30 ------------
  31
  32 For now, unpack your Parrot tarball, (if you're reading this, you've
  33 probably already done that) and type
  34
  35     perl Configure.pl
  36
  37 to run the Configure script. The Configure.pl script extracts
  38 configuration from the running perl5 program.  Unfortunately, the perl5
  39 configuration is not set up to compile and link c++ programs, so you
  40 may need to explicitly tell Configure.pl which compiler and linker to
  41 use.  For example, to compile C files with 'cc', C++ files with
  42 'CC', and link everything together with 'CC', you would type
  43
  44     perl Configure.pl --cc=cc --cxx=CC --link=CC --ld=CC
  45
  46 See "perl Configure.pl --help" for more options and docs/configuration.pod
  47 for more details.
  48
  49 For systems like HPUX that don't have inet_pton please run
  50
  51     perl Configure.pl --define=inet_aton
  52
  53 Running Configure.pl will generate a config.h header, a Parrot::Config
  54 module, platform files and many Makefiles.
  55
  56 The file "myconfig" has an overview of configure settings.
  57
  58 Next, run make. (Configure.pl will tell you which version of make it
  59 recommends for your system.)
  60
  61 Now, the interpreter should build.  If you are building the ICU library
  62 (this is the default on most systems), you need to use GNU make instead
  63 (or something compatible with it).
  64
  65 You can test Parrot by running "make test". You can run the tests in parallel
  66 with "make TEST_JOBS=3 test".
  67
  68 You can run the full test suite with
  69
  70     make fulltest
  71
  72 Note: PLATFORMS contains notes about whether test failures are expected
  73 on your system.
  74
  75 You can install Parrot with:
  76
  77     make install
  78
  79 By default, this installs in /usr/local, with the Parrot executable in
  80 /usr/local/bin. If you want to install Parrot into another location use:
  81
  82     perl Configure.pl --prefix=/Users/foo/parrot-0.7.0
  83     make install
  84
  85 But please note that dynamic libs will not be found for non-standard
  86 locations unless you set LD_LIBRARY_PATH or similar.
  87
  88 Look at docs/parrot.pod and docs/intro.pod for where to go from here.  If you
  89 have any problems, see the section "How To Submit A Bug Report" in
  90 docs/submissions.pod.  These documents are in POD format. You can view these
  91 files with the command:
  92
  93     perldoc -F docs/intro.pod
  94
  95 NOTES
  96 -----
  97
  98 On some older computers with little RAM, the computed-goto dispatch core
  99 (ops/core_ops_cg.c) may take a while to compile or may fail to compile at all.
 100 You can pass a flag to Configure.pl (--cgoto=0) to disable the computed-goto
 101 core, at a slight cost in runtime speed.
 102
 103 CHANGES
 104 -------
 105
 106 For documentation on the user-visible changes between this version and
 107 previous versions, please see NEWS.
 108
 109 MAILING LISTS
 110 -------------
 111
 112 The Parrot user mailing list is parrot-users@lists.parrot.org. Subscribe by
 113 filling out the form at http://lists.parrot.org/mailman/listinfo/parrot-users .
 114 The list is archived at http://lists.parrot.org/pipermail/parrot-users/ .
 115
 116 For development discussions see the information in docs/gettingstarted.pod.
 117
 118 FEEDBACK, PATCHES, etc.
 119 -----------------------
 120
 121 See docs/submissions.pod for more information on reporting bugs and
 122 submitting patches.
 123
 124 WEB SITES
 125 ---------
 126
 127 The following web sites have all the information you need about Parrot:
 128     http://www.parrot.org/
 129     http://trac.parrot.org/
 130
 131 Have fun,
 132    The Parrot Team.