Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 182 lines (115 sloc) 5.203 kb
504e599 @ayardley The Parrot 4.1.0 Release
ayardley authored
1 This is Parrot, version 4.1.0
e21a925 @Whiteknight update version number everywhere
Whiteknight authored
2 ------------------------------
b430ea4 @abh it seems like we indeed can commit. What about sending commit mails?
abh authored
3
6f18d9e @jkeenan Boost copyright date (as README is displayed on our github home page).
jkeenan authored
4 Parrot is Copyright (C) 2001-2012, Parrot Foundation.
b430ea4 @abh it seems like we indeed can commit. What about sending commit mails?
abh authored
5
fac1042 @bschmalhofer Added a couple of Id-tags for SVN.
bschmalhofer authored
6
71830e9 @simoncozens A *real* README file, which doesn't claim it isn't for public
simoncozens authored
7 LICENSE INFORMATION
8 -------------------
526ae3f @abh update README with list address
abh authored
9
d6ab313 @allisonrandal Update license to Artistic 2.0. Resolves RT #43165.
allisonrandal authored
10 This code is distributed under the terms of the Artistic License 2.0.
11 For more details, see the full text of the license in the file LICENSE.
71830e9 @simoncozens A *real* README file, which doesn't claim it isn't for public
simoncozens authored
12
9d2ad19 @coke Mention what we are before we mention what you need.
coke authored
13 OVERVIEW
14 --------
15 Parrot is a virtual machine designed to efficiently compile and execute
16 bytecode for dynamic languages.
17
780c51e Doc Patches
Dan Sugalski authored
18 PREREQUISITES
19 -------------
20
e48569d @bschmalhofer Removed reference to Bundle::Parrot.
bschmalhofer authored
21 You need a C compiler, a linker, and a make program of course.
8cda175 release related changes
Leopold Toetsch authored
22
bd883b0 @chromatic Updated documentation and distribution files for 2.0.0 release.
chromatic authored
23 If you will be linking with the ICU library you have to download and install it
24 before configuring Parrot. Get it from http://site.icu-project.org/download
780c51e Doc Patches
Dan Sugalski authored
25
e48569d @bschmalhofer Removed reference to Bundle::Parrot.
bschmalhofer authored
26 You also need Perl 5.8.4 or newer, and Storable 2.12 or newer
27 for running various configure and build scripts.
780c51e Doc Patches
Dan Sugalski authored
28
ac9dd2b @chromatic Mark our dependency on Perl 5.8.0, per RT #42616.
chromatic authored
29 For most of the platforms that we are supporting initially, Parrot should build
de97af3 @bschmalhofer Removed reference to 'make install-dev' in README.
bschmalhofer authored
30 out of the box. docs/parrot.pod lists the core platforms. PLATFORMS provides
bd883b0 @chromatic Updated documentation and distribution files for 2.0.0 release.
chromatic authored
31 reports on the platforms on which Parrot has been built and tested.
780c51e Doc Patches
Dan Sugalski authored
32
9a0f1b5 @vmax Added "how to get parrot from github" section
vmax authored
33 HOW TO GET PARROT FROM GITHUB
34 -----------------------------
e16b53a @jkeenan Add instructions for obtaining git for Mac OS X. Remove outdated langua...
jkeenan authored
35 I. Install Git.
36
4f9d434 @vmax Added some information, formatted
vmax authored
37 Linux:
38 The method depends on your distribution. To install you should execute (as root or sudo <cmd>):
39
33316f8 @bacek Update README on how to obtain git on modern Debian/Ubuntu
bacek authored
40 On Ubuntu/Debian (old versions, apt-based):
fccfb06 @vmax
vmax authored
41
e0a2fb8 @leto Fix some of the README git instructions
leto authored
42 apt-get install git-core
fccfb06 @vmax
vmax authored
43
33316f8 @bacek Update README on how to obtain git on modern Debian/Ubuntu
bacek authored
44 On Ubuntu/Debian (new versions, apt-based):
45
46 apt-get install git
47
4f9d434 @vmax Added some information, formatted
vmax authored
48 On Red Hat, Fedora (rpm-based):
fccfb06 @vmax
vmax authored
49
e0a2fb8 @leto Fix some of the README git instructions
leto authored
50 yum install git
fccfb06 @vmax
vmax authored
51
4f9d434 @vmax Added some information, formatted
vmax authored
52 on Gentoo (portage):
fccfb06 @vmax
vmax authored
53
e0a2fb8 @leto Fix some of the README git instructions
leto authored
54 emerge -av dev-vcs/git
fccfb06 @vmax
vmax authored
55
4f9d434 @vmax Added some information, formatted
vmax authored
56 Windows:
57 There are 2 Git ports on Windows:
58
e0a2fb8 @leto Fix some of the README git instructions
leto authored
59 msysgit http://code.google.com/p/msysgit/downloads/list
60 TortoiseGit http://code.google.com/p/tortoisegit/downloads/list
9a0f1b5 @vmax Added "how to get parrot from github" section
vmax authored
61
45523d2 @leto [doc] Tweak formatting in README
leto authored
62 Macintosh OS X:
63
e16b53a @jkeenan Add instructions for obtaining git for Mac OS X. Remove outdated langua...
jkeenan authored
64 An Internet search will locate a variety of git installers for Mac OS X,
65 including this:
66
67 http://help.github.com/mac-git-installation/
68
69 II. Obtaining Parrot from github.com
70
e0a2fb8 @leto Fix some of the README git instructions
leto authored
71 To get a copy of the Parrot Git repository:
72
73 git clone git://github.com/parrot/parrot.git
74
1f1054f @leto Don't use git switches that only work in newer gits
leto authored
75 This will checkout the master branch by default. To create a local branch
76 that tracks the branch "some_branch":
e0a2fb8 @leto Fix some of the README git instructions
leto authored
77
1f1054f @leto Don't use git switches that only work in newer gits
leto authored
78 git checkout -b --track some_branch origin/some_branch
fccfb06 @vmax
vmax authored
79
e0a2fb8 @leto Fix some of the README git instructions
leto authored
80 All the above URLs are read-only. If you are a Parrot core developer, then
81 use the read-write URL:
82
83 git clone git@github.com:parrot/parrot.git
84
85 You can view the list of branches at http://github.com/parrot/parrot
fccfb06 @vmax
vmax authored
86
71830e9 @simoncozens A *real* README file, which doesn't claim it isn't for public
simoncozens authored
87 INSTRUCTIONS
88 ------------
89
90 For now, unpack your Parrot tarball, (if you're reading this, you've
780c51e Doc Patches
Dan Sugalski authored
91 probably already done that) and type
71830e9 @simoncozens A *real* README file, which doesn't claim it isn't for public
simoncozens authored
92
66e6aee @moritz recommend Configure.pl --optimize
moritz authored
93 perl Configure.pl --optimize
4dc1384 Updated README to include Configure.pl
Tanton Gibbs authored
94
e16b53a @jkeenan Add instructions for obtaining git for Mac OS X. Remove outdated langua...
jkeenan authored
95 to run the Configure script. The Configure.pl script extracts configuration
96 from the running perl5 program. You may need to explicitly tell Configure.pl
97 which compiler and linker to use. For example, to compile C files with 'cc',
98 C++ files with 'CC', and link everything together with 'CC', you would type
4dc1384 Updated README to include Configure.pl
Tanton Gibbs authored
99
9dadd29 @jkeenan Per TT #2004: Remove remaining references to former '--cxx' option to Co...
jkeenan authored
100 perl Configure.pl --cc=cc --link=CC --ld=CC
79911ba Release changes - s. ChangeLog and NEWS
Leopold Toetsch authored
101
25edf4d @bschmalhofer [docs]
bschmalhofer authored
102 See "perl Configure.pl --help" for more options and docs/configuration.pod
103 for more details.
79911ba Release changes - s. ChangeLog and NEWS
Leopold Toetsch authored
104
c66abb6 - #30095 - prerequisit is perl 5.6
Leopold Toetsch authored
105 For systems like HPUX that don't have inet_pton please run
0846288 various patches 2
Leopold Toetsch authored
106
107 perl Configure.pl --define=inet_aton
108
ac4f257 some notes and fixes
Leopold Toetsch authored
109 Running Configure.pl will generate a config.h header, a Parrot::Config
25edf4d @bschmalhofer [docs]
bschmalhofer authored
110 module, platform files and many Makefiles.
2d256c8 update README
Leopold Toetsch authored
111
79911ba Release changes - s. ChangeLog and NEWS
Leopold Toetsch authored
112 The file "myconfig" has an overview of configure settings.
113
002d0a4 @coke [docs] Cleanup the readme a bit to track change mailing lists, websites,...
coke authored
114 Next, run make. (Configure.pl will tell you which version of make it
115 recommends for your system.)
6f4ccaf small update
Jens Rieks authored
116
117 Now, the interpreter should build. If you are building the ICU library
c66abb6 - #30095 - prerequisit is perl 5.6
Leopold Toetsch authored
118 (this is the default on most systems), you need to use GNU make instead
119 (or something compatible with it).
71830e9 @simoncozens A *real* README file, which doesn't claim it isn't for public
simoncozens authored
120
afd6a1b @allisonrandal [doc] Some cleanups to the main README file preparing for release.
allisonrandal authored
121 You can test Parrot by running "make test". You can run the tests in parallel
002d0a4 @coke [docs] Cleanup the readme a bit to track change mailing lists, websites,...
coke authored
122 with "make TEST_JOBS=3 test".
6f4ccaf small update
Jens Rieks authored
123
124 You can run the full test suite with
125
126 make fulltest
71830e9 @simoncozens A *real* README file, which doesn't claim it isn't for public
simoncozens authored
127
d69278f @coke the testr failures seem to be gone, and we have a
coke authored
128 Note: PLATFORMS contains notes about whether test failures are expected
129 on your system.
cd09134 release 0.1.2 - changed files
Leopold Toetsch authored
130
afd6a1b @allisonrandal [doc] Some cleanups to the main README file preparing for release.
allisonrandal authored
131 You can install Parrot with:
ac4f257 some notes and fixes
Leopold Toetsch authored
132
133 make install
134
afd6a1b @allisonrandal [doc] Some cleanups to the main README file preparing for release.
allisonrandal authored
135 By default, this installs in /usr/local, with the Parrot executable in
136 /usr/local/bin. If you want to install Parrot into another location use:
15962a5 update README for recent make install changes
Leopold Toetsch authored
137
560ee08 @coke use a less confusing sample install dir.
coke authored
138 perl Configure.pl --prefix=/home/joe/bird
f2ad61b @coke fixup 'make install' documentation. Consolidate and Repair.
coke authored
139 make install
15962a5 update README for recent make install changes
Leopold Toetsch authored
140
141 But please note that dynamic libs will not be found for non-standard
142 locations unless you set LD_LIBRARY_PATH or similar.
ac4f257 some notes and fixes
Leopold Toetsch authored
143
162d1ed @chromatic Added list of known broken subsystems and pieces. Someday we can autoge...
chromatic authored
144 Look at docs/parrot.pod and docs/intro.pod for where to go from here. If you
a1d5a0c @pmichaud [release]:
pmichaud authored
145 have any problems, see the section "How To Submit A Bug Report" in
146 docs/submissions.pod. These documents are in POD format. You can view these
fb4f8a1 @coke [docs]
coke authored
147 files with the command:
7d4ba24 release 0.1.0 preparation
Leopold Toetsch authored
148
149 perldoc -F docs/intro.pod
71830e9 @simoncozens A *real* README file, which doesn't claim it isn't for public
simoncozens authored
150
39b2ae0 @simoncozens README, NEWS and MANIFEST? Could it be time for Parrot 0.0.2? I think so...
simoncozens authored
151 CHANGES
152 -------
153
154 For documentation on the user-visible changes between this version and
8cda175 release related changes
Leopold Toetsch authored
155 previous versions, please see NEWS.
9d8afb3 @rspier Add viewcvs link
rspier authored
156
8d0789c @abh add a few lines about lists.
abh authored
157 MAILING LISTS
158 -------------
159
de97af3 @bschmalhofer Removed reference to 'make install-dev' in README.
bschmalhofer authored
160 The Parrot user mailing list is parrot-users@lists.parrot.org. Subscribe by
161 filling out the form at http://lists.parrot.org/mailman/listinfo/parrot-users .
162 The list is archived at http://lists.parrot.org/pipermail/parrot-users/ .
163
164 For development discussions see the information in docs/gettingstarted.pod.
002d0a4 @coke [docs] Cleanup the readme a bit to track change mailing lists, websites,...
coke authored
165
4bf9d86 @coke [docs]
coke authored
166 FEEDBACK, PATCHES, etc.
df6f428 @bschmalhofer [docs] Use the regukar char for underlining
bschmalhofer authored
167 -----------------------
4bf9d86 @coke [docs]
coke authored
168
de97af3 @bschmalhofer Removed reference to 'make install-dev' in README.
bschmalhofer authored
169 See docs/submissions.pod for more information on reporting bugs and
4bf9d86 @coke [docs]
coke authored
170 submitting patches.
171
52abf72 @simoncozens README good to go.
simoncozens authored
172 WEB SITES
173 ---------
8d0789c @abh add a few lines about lists.
abh authored
174
002d0a4 @coke [docs] Cleanup the readme a bit to track change mailing lists, websites,...
coke authored
175 The following web sites have all the information you need about Parrot:
176 http://www.parrot.org/
c762e42 @coke Add pointer to docs website.
coke authored
177 http://docs.parrot.org/
dc3d65b @moritz replace some references to trac.parrot.org with the appropriate links to...
moritz authored
178 https://github.com/parrot/parrot/
8d0789c @abh add a few lines about lists.
abh authored
179
71830e9 @simoncozens A *real* README file, which doesn't claim it isn't for public
simoncozens authored
180 Have fun,
17f5148 @bschmalhofer These are some documentation tidbits:
bschmalhofer authored
181 The Parrot Team.
Something went wrong with that request. Please try again.