Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 196 lines (122 sloc) 5.696 kb
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
1 # Copyright (C) 2001-2012, Parrot Foundation.
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
2
3 =pod
4
5 =head1 NAME
6
31a5f7e @rurban Release 4.11.0 - All together - Happy Birthday Lovebird
rurban authored
7 README.pod - Readme to Parrot, version 4.11.0.
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
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
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
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.
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
26
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
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.
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
29
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
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
32 on the platforms on which Parrot has been built and tested.
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
33
34 =head1 HOW TO GET PARROT FROM GITHUB
35
36 =head2 I. Install Git.
37
38 Linux:
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
39 The method depends on your distribution. To install you should execute (as
40 root or sudo <cmd>):
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
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:
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
61 An Internet search will locate a variety of git installers for Mac OS X, for
62 example,
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
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
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
72 This will checkout the master branch by default. To create a local branch
73 which tracks the branch "some_branch":
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
74
75 git checkout -b --track some_branch origin/some_branch
76
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
77 All the above URLs are read-only. If you are a Parrot core developer, then
78 use the read-write URL:
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
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
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
86 For now, unpack your Parrot tarball, (if you're reading this, you've probably
87 already done that) and type
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
88
89 perl Configure.pl --optimize
90
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
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
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
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
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
111 Next, run 'make'. ('Configure.pl' will tell you which version of 'make' it
112 recommends for your system.)
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
113
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
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).
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
117
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
118 You can test Parrot by running 'make test'. You can run the tests in parallel
119 with 'make TEST_JOBS=3 test'.
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
120
121 You can run the full test suite with
122
123 make fulltest
124
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
125 NOTE: PLATFORMS contains notes about whether test failures are expected on
126 your system.
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
127
128 You can install Parrot with,
129
130 make install
131
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
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:
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
135
136 perl Configure.pl --prefix=/dir/to/install/
137 make install
138
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
139 But please note, the dynamic libs will not be found for non-standard locations
f13c22a @ayardley Added a'bit about how to obtain html-ized docs.
ayardley authored
140 unless you set the environment variable 'LD_LIBRARY_PATH' or something similar.
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
141
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
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
145 in POD format, and you can view them with the command,
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
146
147 perldoc -F docs/intro.pod
148
f13c22a @ayardley Added a'bit about how to obtain html-ized docs.
ayardley authored
149 In addition, you may obtain an html-ized version of our docs -- which, in
150 some respects, are more extensive than our POD documents -- with the following
151 command:
152
bb8c98f @azawawi 'make html' needs to have JSON installed
azawawi authored
153 cpan JSON # Needed by the next command
f13c22a @ayardley Added a'bit about how to obtain html-ized docs.
ayardley authored
154 make html
155
156 You may then view a local copy of the html documentation by navigating your
157 favorite browser to the index page of the 'docs/html/' directory, I<i.e.,>
158 'docs/html/index.html'.
159
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
160 =head1 CHANGES
161
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
162 For documentation on the user-visible changes between this and previous
163 versions of Parrot, I<see> 'ChangeLog'.
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
164
165 =head1 MAILING LISTS
166
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
167 The Parrot user mailing list is 'parrot-users@lists.parrot.org'. You may
168 subscribe to the mailing list by filling out the form at
169 http://lists.parrot.org/mailman/listinfo/parrot-users. There is an archive
170 of the mailing list at http://lists.parrot.org/pipermail/parrot-users/.
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
171
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
172 For development discussions, I<see> the information in
173 F<docs/gettingstarted.pod>.
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
174
175 =head1 FEEDBACK, PATCHES, etc.
176
e254d52 @ayardley Update the tests to use 'README.pod' && a update to the copyright date o...
ayardley authored
177 For more information on how to report bugs and to submit patches, I<see>
178 F<docs/submissions.pod>.
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
179
180 =head1 WEB SITES
181
182 For more information on Parrot, I<see>
183
184 http://www.parrot.org/
185 http://docs.parrot.org/
186 http://parrot.github.com/
187
188 Have fun,
189 The Parrot Team.
190
b57d5c5 @ayardley Included an overt copyright notice at the end of the document.
ayardley authored
191 =head1 COPYRIGHT
192
193 Copyright (C) 2001-2012, Parrot Foundation.
194
a827f5d @ayardley Update the main repo 'README' to pod.
ayardley authored
195 =cut
Something went wrong with that request. Please try again.