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