README

   1 This is Parrot, version 0.5.2
   2 ------------------------------
   3
   4 Parrot is Copyright (C) 2001-2008, The Perl 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. If you will be
  18 linking with the ICU library you have to download and install it before
  19 configuring Parrot.
  20
  21 Get it from http://www-306.ibm.com/software/globalization/icu/downloads.jsp
  22
  23 You also need Perl 5.8.0 or newer to run 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.  The list of targeted platforms can be found in PLATFORMS.
  27
  28 The current configure system is primitive, as it's only
  29 a temporary solution. It will be happy with most any answers
  30 you decide to feed it. Garbage In, Garbage Out.
  31
  32 INSTRUCTIONS
  33 ------------
  34
  35 For now, unpack your Parrot tarball, (if you're reading this, you've
  36 probably already done that) and type
  37
  38     perl Configure.pl
  39
  40 to run the Configure script. The Configure.pl script extracts
  41 configuration from the running perl5 program.  Unfortunately, the perl5
  42 configuration is not set up to compile and link c++ programs, so you
  43 may need to explicitly tell Configure.pl which compiler and linker to
  44 use.  For example, to compile C files with 'cc', C++ files with
  45 'CC', and link everything together with 'CC', you would type
  46
  47     perl Configure.pl --cc=cc --cxx=CC --link=CC --ld=CC
  48
  49 See "perl Configure.pl --help" for more options.
  50
  51 For systems like HPUX that don't have inet_pton please run
  52
  53     perl Configure.pl --define=inet_aton
  54
  55 Running Configure.pl will generate a config.h header, a Parrot::Config
  56 module, platform files and some Makefiles.
  57
  58 The file "myconfig" has an overview of configure settings.
  59
  60 Next, run make:
  61
  62 For UNIX like systems that come with its own make, 'gmake' should be
  63 used.  (On most Linux systems, this is the default make.)
  64
  65 On windows systems, 'nmake' is used
  66
  67 On other systems, just try 'make'
  68
  69 Now, the interpreter should build.  If you are building the ICU library
  70 (this is the default on most systems), you need to use GNU make instead
  71 (or something compatible with it).
  72
  73 NOTE: If you have trouble linking parrot, this *may* be due to a pre-existing
  74 parrot version installed via 'make install'. Until this issue is resolved,
  75 you may have to delete the installed version of parrot before building a new
  76 one. Our apologies.
  77
  78 You can test parrot by running
  79
  80     make test         (or nmake test or gmake test)
  81
  82 You can run the full test suite with
  83
  84     make fulltest
  85
  86 Note: PLATFORMS contains notes about whether test failures are expected
  87 on your system.
  88
  89 On some systems you can install parrot:
  90
  91     make install
  92
  93 This installs a bunch of files in /usr/local. The parrot executable is in
  94 /usr/local/bin.   Please note that this feature is currently experimental.
  95
  96 If you want to install Parrot into a non-standard location use:
  97
  98     perl Configure.pl --prefix=/Users/foo/parrot-0.5.0
  99     make install
 100
 101 But please note that dynamic libs will not be found for non-standard
 102 locations unless you set LD_LIBRARY_PATH or similar.
 103
 104 Look at docs/parrot.pod and docs/intro.pod for where to go from here.  If you
 105 have any problems, see the section "How To Submit A Bug Report" in
 106 docs/submissions.pod These documents are in POD format. You can view these
 107 files with the command:
 108
 109     perldoc -F docs/intro.pod
 110
 111 NOTES
 112 -----
 113
 114 On some older computers with little RAM, the computed-goto dispatch core
 115 (ops/core_ops_cg.c) may take a while to compile or may fail to compile at all.
 116 You can pass a flag to Configure.pl (--cgoto=0) to disable the computed-goto
 117 core, at a slight cost in runtime speed.
 118
 119 CHANGES
 120 -------
 121
 122 For documentation on the user-visible changes between this version and
 123 previous versions, please see NEWS.
 124
 125 MAILING LISTS
 126 -------------
 127
 128 The mailing list for parrot is parrot-porters.  Subscribe by sending mail to
 129 parrot-porters-subscribe@perl.org. It is archived at
 130 http://www.nntp.perl.org/group/perl.perl6.internals
 131 and available via NNTP at nntp://nntp.perl.org/perl.perl6.internals
 132
 133 You can also read the list via Google Groups at
 134 http://groups-beta.google.com/group/perl.perl6.internals
 135
 136 FEEDBACK, PATCHES, etc.
 137 _______________________
 138
 139 See F<docs/submissions.pod> for more information on reporting bugs and
 140 submitting patches.
 141
 142 WEB SITES
 143 ---------
 144
 145 The following web sites have all the Parrot information you need:
 146     http://www.parrotcode.org/
 147     http://dev.perl.org/perl6/
 148     http://bugs6.perl.org/perl6/
 149     http://pugscode.org/
 150
 151 Have fun,
 152    The Parrot Team.