README

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