Skip to content

HTTPS clone URL

Subversion checkout URL

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