Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 166 lines (118 sloc) 6.359 kb
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
1 This is Rakudo Star, a useful, usable Perl 6 distribution for "early adopters".
060768e @pmichaud first commit
pmichaud authored
2
da8a9d3 @moritz Bump some versions
moritz authored
3 This is the 2015.03 release of Rakudo Star.
263f239 @moritz inital script for downloading rakudo and modules
moritz authored
4
52105c5 @moritz adopt versions in tools/build/Makefile.in and README
moritz authored
5 Rakudo Star is Copyright (C) 2010 - 2015 by the Rakudo Star Team.
b237f27 @moritz [README] be more verbose about not building distributions, unless you…
moritz authored
6
fb9b17e @paultcochrane Wrap paragraphs and vertically separate sections consistently
paultcochrane authored
7
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
8 License Information
9 -------------------
10 Rakudo Star is distributed under the terms of the Artistic License 2.0.
11 This distribution contains software collected from other sources; see the
3be6a38 @moritz Prepare parrot suspension
moritz authored
12 individual source subdirectories (in rakudo/, MoarVM/ and modules/)
4700659 @jnthn Update README for multi-backend Star.
jnthn authored
13 for copyright and licensing information of those components.
b237f27 @moritz [README] be more verbose about not building distributions, unless you…
moritz authored
14
fb9b17e @paultcochrane Wrap paragraphs and vertically separate sections consistently
paultcochrane authored
15
4700659 @jnthn Update README for multi-backend Star.
jnthn authored
16 Overview
17 --------
fb9b17e @paultcochrane Wrap paragraphs and vertically separate sections consistently
paultcochrane authored
18 The Rakudo Perl 6 compiler can target MoarVM and the JVM. Rakudo Star fully
19 supports MoarVM; not all modules work on the JVM at present. You can choose
20 to build and install Rakudo for one or more of these virtual machines at
21 configure time.
4700659 @jnthn Update README for multi-backend Star.
jnthn authored
22
23
24 Build Prerequisites for Rakudo on MoarVM
25 ----------------------------------------
26 To build Rakudo Star on MoarVM, you need at least a 'make' utility, a C
27 compiler, and Perl 5.10.0 or newer. Building Rakudo on MoarVM needs a
28 machine with a gigabyte of memory; for a 32-bit build, you may get by
29 with less.
263f239 @moritz inital script for downloading rakudo and modules
moritz authored
30
6b6a829 @pmichaud Update the README.
pmichaud authored
31
4700659 @jnthn Update README for multi-backend Star.
jnthn authored
32 Build Prerequisites for Rakudo on the JVM
33 -----------------------------------------
fb9b17e @paultcochrane Wrap paragraphs and vertically separate sections consistently
paultcochrane authored
34 To build Rakudo Star on the JVM, you need at least a 'make' utility, both
35 'java' and 'javac' available in your path, and Perl 5.10.0 or newer. The
36 'java' and 'javac' are obtained by installing a Java Development kit, for
37 example openjdk-7 or the Oracle JDK.
4700659 @jnthn Update README for multi-backend Star.
jnthn authored
38
fb9b17e @paultcochrane Wrap paragraphs and vertically separate sections consistently
paultcochrane authored
39 The newer the JDK you have the better; due to bugs in the invokedynamic
40 instruction in early JDK7 releases, JDK7 update 21 or above is suggested.
41 JDK8, if available, is better still. The build can complete within a gigabyte
42 of memory.
4700659 @jnthn Update README for multi-backend Star.
jnthn authored
43
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
44
4700659 @jnthn Update README for multi-backend Star.
jnthn authored
45 Configuring Rakudo Star
46 -----------------------
47 The easiest way to build Rakudo Star for a particular backend is:
48
49 $ perl Configure.pl --backend=moar --gen-moar # MoarVM
50 $ perl Configure.pl --backend=jvm --gen-nqp # JVM
51
52 You can also build for all backends:
53
3be6a38 @moritz Prepare parrot suspension
moritz authored
54 $ perl Configure.pl --backend=jvm,moar --gen-moar
4700659 @jnthn Update README for multi-backend Star.
jnthn authored
55
438a4c3 @paultcochrane Fix minor typos
paultcochrane authored
56 Note that --gen-moar automatically builds a MoarVM for you, and implies
3be6a38 @moritz Prepare parrot suspension
moritz authored
57 --gen-nqp, which builds NQP, a subset of Perl 6 that is used to implement
58 Rakudo.
4700659 @jnthn Update README for multi-backend Star.
jnthn authored
59
fb9b17e @paultcochrane Wrap paragraphs and vertically separate sections consistently
paultcochrane authored
60 Configured this way, one or more Perl 6 executables and selected Perl 6
61 modules will be installed into the install/ subdirectory, which resides inside
62 the source archive directory. Running make install will *not* install anything
63 into /usr/local. If you want to change this behavior, specify the install
64 prefix using the --prefix option.
4700659 @jnthn Update README for multi-backend Star.
jnthn authored
65
66
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
67 Building Rakudo Star
68 --------------------
4700659 @jnthn Update README for multi-backend Star.
jnthn authored
69 After configuration, build Rakudo Star with:
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
70
71 $ make
72 $ make install
73
4700659 @jnthn Update README for multi-backend Star.
jnthn authored
74 Once Rakudo Star is installed, you can run Perl 6 programs by doing:
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
75
76 $ ./perl6 hello.pl
77
fb9b17e @paultcochrane Wrap paragraphs and vertically separate sections consistently
paultcochrane authored
78 Programs can also be run by adding the "install/bin" directory to your PATH
79 environment variable.
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
80
fb9b17e @paultcochrane Wrap paragraphs and vertically separate sections consistently
paultcochrane authored
81 If the Rakudo compiler is invoked without an explicit script to run, it enters
82 a small interactive mode that allows Perl 6 statements to be executed from the
83 command line.
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
84
85
86 Running the Perl 6 test suite
87 -----------------------------
fb9b17e @paultcochrane Wrap paragraphs and vertically separate sections consistently
paultcochrane authored
88 Entering "make rakudo-test" will run a small test suite that comes bundled
89 with Rakudo. This is a simple suite of tests, designed to make sure that the
90 Rakudo compiler is basically working and that it's capable of running a simple
91 test harness.
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
92
fb9b17e @paultcochrane Wrap paragraphs and vertically separate sections consistently
paultcochrane authored
93 Running "make rakudo-spectest" will run the Perl 6 specification test suite
94 ("roast") that was bundled with the Rakudo compiler release.
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
95
fb9b17e @paultcochrane Wrap paragraphs and vertically separate sections consistently
paultcochrane authored
96 Running "make modules-test" will run the test suites of any installed modules.
97 The modules currently have to be installed (via 'make install' or 'make
98 modules-install') before the tests can be run.
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
99
4700659 @jnthn Update README for multi-backend Star.
jnthn authored
100
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
101 Release information
102 -------------------
fb9b17e @paultcochrane Wrap paragraphs and vertically separate sections consistently
paultcochrane authored
103 Information about the current release is placed in the docs/ directory, here
104 is a brief overview:
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
105
106 docs/cheatsheet.txt — Perl 6 cheat sheet
107 docs/announce/ — detailed release announcements
108
109
110 Where to get help or answers to questions
111 -----------------------------------------
fb9b17e @paultcochrane Wrap paragraphs and vertically separate sections consistently
paultcochrane authored
112 The http://perl6.org/ website contains a great many links to resources for
113 Perl 6 development, and is generally the starting point for information about
114 Perl 6.
115
116 There are several mailing lists, IRC channels, and wikis available with help
117 for Perl 6 and Rakudo. Figuring out the right one to use is often the biggest
118 battle. Here are some rough guidelines:
119
120 If you have a question about Perl 6 syntax or the right way to approach a
121 problem using Perl 6, you probably want the perl6-users@perl.org mailing list.
122 This list is primarily for the people who want to use Perl 6 to write
123 programs, as opposed to those who are implementing or developing the Perl 6
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
124 language itself.
125
3be6a38 @moritz Prepare parrot suspension
moritz authored
126 Questions about the Rakudo compiler can go to perl6-compiler@perl.org.
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
127
3be6a38 @moritz Prepare parrot suspension
moritz authored
128 The Rakudo and MoarVM development teams tend to hang out on IRC a fair
129 bit, on irc.freenode.net/#perl6 and irc.freenode.net/#moarvm, respectively.
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
130
438a4c3 @paultcochrane Fix minor typos
paultcochrane authored
131 Rakudo's official web site is http://rakudo.org/, where you can
1018ddd @paultcochrane Purge trailing whitespace
paultcochrane authored
132 find useful information for developers and users alike.
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
133
134
135 Reporting bugs
136 --------------
fb9b17e @paultcochrane Wrap paragraphs and vertically separate sections consistently
paultcochrane authored
137 Bug reports about Rakudo Star or the Perl 6 specification should be sent to
138 rakudobug@perl.org with the moniker [BUG] (including the brackets) at the
139 start of the subject so that it gets appropriately tagged in the RT system
140 (https://rt.perl.org/rt3/). Please include or attach any sample source code
141 that exhibits the bug, and include either the release name/date or the git
142 commit identifier. You find this information in the output from "perl6
143 --version". There's no need to Cc: the perl6-compiler mailing list, as the RT
144 system will handle this on its own.
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
145
146
147 Submitting patches
148 ------------------
149 Patches to the Rakudo compiler itself should be submitted to
fb9b17e @paultcochrane Wrap paragraphs and vertically separate sections consistently
paultcochrane authored
150 'rakudobug@perl.org'. Patches for individual modules should be submitted to
151 the module authors (see the module source code for details).
152
153 We'll generally accept patches in any form if we can get them to work, but
154 unified diff from the 'git' command is greatly preferred. See further
155 instructions in the rakudo/ subdirectory for more details. Other ways to
156 create and submit patches are discussed at
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
157 http://wiki.github.com/rakudo/rakudo/steps-to-create-a-patch.
158
fb9b17e @paultcochrane Wrap paragraphs and vertically separate sections consistently
paultcochrane authored
159
c012d8b @pmichaud Move skel/ into top-level directory, to try building directly from th…
pmichaud authored
160 AUTHOR
161 ------
fb9b17e @paultcochrane Wrap paragraphs and vertically separate sections consistently
paultcochrane authored
162 Patrick Michaud (pmichaud@pobox.com) is the primary author and maintainer for
163 Rakudo Star. See docs/CREDITS for further Rakudo Star authors, and */CREDITS
164 for authors of other collected components.
cdfda83 @pmichaud Update star repo README a bit.
pmichaud authored
165
Something went wrong with that request. Please try again.