README

   1 This is Parrot, version 0.4.1
   2 -----------------------------
   3
   4 Parrot is Copyright (C) 2001-2006, The Perl Foundation.
   5
   6 $Id$
   7
   8 LICENSE INFORMATION
   9 -------------------
  10
  11 This code is distributed under the same license as Perl 5; you can
  12 redistribute it and/or modify it under the terms of either:
  13
  14     a) the GNU General Public License as found in the directory "LICENSES"
  15
  16     b) the "Artistic License" which can be found in the directory "LICENSES"
  17
  18 This program is distributed in the hope that it will be useful,
  19 but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See either
  21 the GNU General Public License or the Artistic License for more details.
  22
  23 PREREQUISITES
  24 -------------
  25
  26 You'll need a C compiler, a linker and a make program of course. If you
  27 will be linking with the ICU library you have to download and install it
  28 before configuring Parrot.
  29
  30 Get it from http://www-306.ibm.com/software/globalization/icu/downloads.jsp
  31
  32 You'll also need Perl 5.6 or above to run various configure and
  33 build scripts.
  34
  35 For most of the platforms that we are supporting initially,
  36 Parrot should build out of the box.
  37 The list of targeted platforms can be found in PLATFORMS.
  38
  39 The current configure system is primitive, as it's only
  40 a temporary solution. It will be happy with most any answers
  41 you decide to feed it. Garbage In, Garbage Out.
  42
  43 INSTRUCTIONS
  44 ------------
  45
  46 For now, unpack your Parrot tarball, (if you're reading this, you've
  47 probably already done that) and type
  48
  49     perl Configure.pl
  50
  51 to run the Configure script. The Configure.pl script extracts
  52 configuration from the running perl5 program.  Unfortunately, the perl5
  53 configuration is not set up to compile and link c++ programs, so you
  54 may need to explicitly tell Configure.pl which compiler and linker to
  55 use.  For example, to compile C files with 'cc', C++ files with
  56 'CC', and link everything together with 'CC', you would type
  57
  58     perl Configure.pl --cc=cc --cxx=CC --link=CC --ld=CC
  59
  60 See "perl Configure.pl --help" for more options.
  61
  62 For systems like HPUX that don't have inet_pton please run
  63
  64     perl Configure.pl --define=inet_aton
  65
  66 If you want to install Parrot into a non-standard location use
  67
  68     perl Configure.pl --prefix=/Users/foo/parrot-0.4.1
  69
  70 Running Configure.pl will generate a config.h header, a Parrot::Config
  71 module, platform files and some Makefiles.
  72
  73 The file "myconfig" has an overview of configure settings.
  74
  75 Next, run make:
  76
  77 For UNIX like systems that come with its own make, 'gmake' should be
  78 used.  (On most Linux systems, this is the default make.)
  79
  80 On windows systems, 'nmake' is used
  81
  82 On other systems, just try 'make'
  83
  84 Now, the interpreter should build.  If you are building the ICU library
  85 (this is the default on most systems), you need to use GNU make instead
  86 (or something compatible with it).
  87
  88 You can test parrot by running
  89
  90     make test         (or nmake test or gmake test)
  91
  92 You can run the full test suite with
  93
  94     make fulltest
  95
  96 Note: PLATFORMS contains notes about whether test failures are expected
  97 on your system.
  98
  99 On some systems you can install parrot:
 100
 101     make install
 102
 103 This installs a bunch of files in /usr/local. The parrot executable is in
 104 /usr/local/bin.   Please note that this feature is currently experimental.
 105
 106 You can install into a different location with:
 107
 108     make install --prefix=/home/foo/bar
 109
 110 But please note that dynamic libs will not be found for non-standard
 111 locations unless you set LD_LIBRARY_PATH or similar.
 112
 113 Look at docs/parrot.pod and docs/intro.pod for where to go from here.  If you
 114 have any problems, see the section "Reporting Problems" in docs/intro.pod.
 115 These documents are in POD format. You can view these files with:
 116
 117     perldoc -F docs/intro.pod
 118
 119 NOTES
 120 -----
 121
 122 On some older computers with little RAM, the computed-goto dispatch core
 123 (ops/core_ops_cg.c) may take a while to compile or may fail to compile at all.
 124 You can pass a flag to Configure.pl (--cgoto=0) to disable the computed-goto
 125 core, at a slight cost in runtime speed.
 126
 127 CHANGES
 128 -------
 129
 130 For documentation on the user-visible changes between this version and
 131 previous versions, please see NEWS.
 132
 133 KNOWN ISSUES
 134 ------------
 135
 136 The docs/BROKEN file lists other major subsystems and regressions that block
 137 progress.
 138
 139 MAILING LISTS
 140 -------------
 141
 142 The mailing list for parrot is perl6-internals.  Subscribe by sending mail to
 143 perl6-internals-subscribe@perl.org. It is archived at
 144 http://www.nntp.perl.org/group/perl.perl6.internals
 145 and available via NNTP at nntp://nntp.perl.org/perl.perl6.internals
 146
 147 You can also read the list via Google Groups at
 148 http://groups-beta.google.com/group/perl.perl6.internals
 149
 150 WEB SITES
 151 ---------
 152
 153 The following web sites have all the Parrot information you need:
 154     http://www.parrotcode.org/
 155     http://dev.perl.org/perl6/
 156     http://bugs6.perl.org/
 157     http://pugscode.org/
 158     http://www.poniecode.org/
 159
 160 Have fun,
 161    The Parrot Team.