Skip to content
This repository
Newer
Older
100644 181 lines (112 sloc) 5.253 kb
10fd17f3 »
2011-11-28 Added new README.pod
1 # Copyright (C) 2001-2011, Parrot Foundation.
2
3 =pod
4
5 =head1 NAME
6
7 README.pod - Readme to Parrot, version 3.10.0.
8
9 =head1 DESCRIPTION
10
11 Parrot is a virtual machine designed to, efficiently, compile and execute
12 bytecode for dynamic languages.
13
14 =head1 LICENSE
15
16 This code is distributed under the terms of the Artistic License 2.0.
17 For more details, see the full text of the license in the file 'LICENSE'.
18
19 =head1 PREREQUISITES
20
21 You need a C compiler, a linker, and a 'make' program.
22
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
23 If you plan to link Parrot with the ICU library, you must download and install
24 it I<before> configuring Parrot. You may obtain the ICU library at
25 http://site.icu-project.org/download.
10fd17f3 »
2011-11-28 Added new README.pod
26
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
27 You will also need Perl 5.8.4 or newer and Storable 2.12 or newer in order to
28 run various configure and build scripts.
10fd17f3 »
2011-11-28 Added new README.pod
29
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
30 For most of the platforms we support, Parrot should build out-of-the-box.
31 'docs/parrot.pod' lists the core platforms, and 'PLATFORMS' provides reports on
32 the platforms on which Parrot has been built and tested.
10fd17f3 »
2011-11-28 Added new README.pod
33
34 =head1 HOW TO GET PARROT FROM GITHUB
35
36 =head2 I. Install Git.
37
38 Linux:
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
39 The method depends on your distribution. To install you should execute (as root
40 or sudo <cmd>):
10fd17f3 »
2011-11-28 Added new README.pod
41
42 On Ubuntu/Debian (apt-based):
43
44 apt-get install git-core
45
46 On Red Hat, Fedora (rpm-based):
47
48 yum install git
49
50 on Gentoo (portage):
51
52 emerge -av dev-vcs/git
53
54 Windows:
55 There are 2 Git ports on Windows:
56
57 msysgit http://code.google.com/p/msysgit/downloads/list
58 TortoiseGit http://code.google.com/p/tortoisegit/downloads/list
59
60 Macintosh OS X:
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
61 An Internet search will locate a variety of git installers for Mac OS X, for
62 example,
10fd17f3 »
2011-11-28 Added new README.pod
63
64 http://help.github.com/mac-git-installation/
65
66 =head2 II. Obtaining Parrot from github.com
67
68 To obtain a copy of the Parrot Git repository:
69
70 git clone git://github.com/parrot/parrot.git
71
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
72 This will checkout the master branch by default. To create a local branch which
73 tracks the branch "some_branch":
10fd17f3 »
2011-11-28 Added new README.pod
74
75 git checkout -b --track some_branch origin/some_branch
76
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
77 All the above URLs are read-only. If you are a Parrot core developer, then use
78 the read-write URL:
10fd17f3 »
2011-11-28 Added new README.pod
79
80 git clone git@github.com:parrot/parrot.git
81
82 You can view the list of branches at http://github.com/parrot/parrot
83
84 =head1 INSTRUCTIONS
85
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
86 For now, unpack your Parrot tarball, (if you're reading this, you've probably
87 already done that) and type
10fd17f3 »
2011-11-28 Added new README.pod
88
89 perl Configure.pl --optimize
90
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
91 to run the Configure script. The 'Configure.pl' script extracts configuration
92 information from the running perl5 program. You may need to explicitly tell
93 'Configure.pl' which compiler and linker to use. For example, to compile C
94 files with 'cc', C++ files with 'CC', and link everything together with 'CC',
95 you would type
10fd17f3 »
2011-11-28 Added new README.pod
96
97 perl Configure.pl --cc=cc --link=CC --ld=CC
98
99 I<See> 'perl Configure.pl --help' for more options and 'docs/configuration.pod'
100 for more details.
101
102 For systems like HPUX that don't have inet_pton please run
103
104 perl Configure.pl --define=inet_aton
105
106 Running 'Configure.pl' will generate a 'config.h' header, a 'Parrot::Config'
107 module, platform files, and many Makefiles.
108
109 The file 'myconfig' has an overview of configure settings.
110
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
111 Next, run 'make'. ('Configure.pl' will tell you which version of 'make' it
112 recommends for your system.)
10fd17f3 »
2011-11-28 Added new README.pod
113
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
114 Now, the interpreter should build. If you are building the ICU library (this
115 is the default on most systems), you need to use 'GNU make' instead (or
116 something compatible with it).
10fd17f3 »
2011-11-28 Added new README.pod
117
b39e6f8e »
2012-04-15 Minor edit to conform to 78 character limit.
118 You can test Parrot by running 'make test'. You can run the tests in parallel
119 with 'make TEST_JOBS=3 test'.
10fd17f3 »
2011-11-28 Added new README.pod
120
121 You can run the full test suite with
122
123 make fulltest
124
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
125 NOTE: PLATFORMS contains notes about whether test failures are expected on your
126 system.
10fd17f3 »
2011-11-28 Added new README.pod
127
128 You can install Parrot with,
129
130 make install
131
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
132 By default, this installs in '/usr/local', with the Parrot executable in
133 '/usr/local/bin'. If you want to install Parrot into another location use the
134 following:
10fd17f3 »
2011-11-28 Added new README.pod
135
136 perl Configure.pl --prefix=/dir/to/install/
137 make install
138
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
139 But please note, the dynamic libs will not be found for non-standard locations
140 unless you set the enviornment variable 'LD_LIBRARY_PATH' or something similar.
10fd17f3 »
2011-11-28 Added new README.pod
141
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
142 For where to go from here, I<see> F<docs/parrot.pod> and I<see>
143 F<docs/intro.pod>. If you experience problems, please I<see> the section
144 "How To Submit A Bug Report" in F<docs/submissions.pod>. These documents are in
145 POD format, and you can view them with the command,
10fd17f3 »
2011-11-28 Added new README.pod
146
147 perldoc -F docs/intro.pod
148
149 =head1 CHANGES
150
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
151 For documentation on the user-visible changes between this and previous
152 versions of Parrot, I<see> 'ChangeLog'.
10fd17f3 »
2011-11-28 Added new README.pod
153
154 =head1 MAILING LISTS
155
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
156 The Parrot user mailing list is 'parrot-users@lists.parrot.org'. You may
157 subscribe to the mailing list by filling out the form at
158 http://lists.parrot.org/mailman/listinfo/parrot-users. There is an archive of
159 the mailing list at http://lists.parrot.org/pipermail/parrot-users/.
10fd17f3 »
2011-11-28 Added new README.pod
160
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
161 For development discussions, I<see> the information in
162 F<docs/gettingstarted.pod>.
10fd17f3 »
2011-11-28 Added new README.pod
163
164 =head1 FEEDBACK, PATCHES, etc.
165
2f2764cf »
2011-12-18 Update doc to conform to supposed 78 character length.
166 For more information on how to report bugs and to submit patches, I<see>
167 F<docs/submissions.pod>.
10fd17f3 »
2011-11-28 Added new README.pod
168
169 =head1 WEB SITES
170
171 For more information on Parrot, I<see>
172
173 http://www.parrot.org/
174 http://docs.parrot.org/
175 http://parrot.github.com/
176
177 Have fun,
178 The Parrot Team.
179
180 =cut
Something went wrong with that request. Please try again.