Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 90 lines (72 sloc) 4.342 kb
fe29cde @coke README should be in text, not POD.
coke authored
1 Rakudo Perl 6
2 This is Rakudo Perl, a Perl 6 compiler for the Parrot virtual machine.
1b6cbf6 @pmichaud First draft of a perl 6 parser in p6 rules and pir.
pmichaud authored
3
039d75f @pmichaud Add a prerequisite section to the README (szabgab++). Update copyright.
pmichaud authored
4 Rakudo Perl is Copyright (C) 2008-2012, The Perl Foundation. Rakudo Perl
fe29cde @coke README should be in text, not POD.
coke authored
5 is distributed under the terms of the Artistic License 2.0. For more
6 details, see the full text of the license in the file LICENSE.
1b6cbf6 @pmichaud First draft of a perl 6 parser in p6 rules and pir.
pmichaud authored
7
19931fe @pmichaud Update README with pointer to Rakudo Star distributions.
pmichaud authored
8 This directory contains only the Rakudo Perl 6 compiler itself; it
9 does not contain any of the modules, documentation, or other items
10 that would normally come with a full Perl 6 distribution. If you're
11 after more than just the bare compiler, please download the latest
12 Rakudo Star package from http://github.com/rakudo/star/downloads .
ec2f831 @Daenyth README: Added section about Rakudo packages, and a link to the Arch Linu...
Daenyth authored
13
cbdfa61 @moritz [README] add pointer to status page
moritz authored
14 For a high-level overview of implemented and missing features,
15 please visit http://perl6.org/compilers/features .
16
90f996e @moritz move most of the build instructions into a separate INSTALL file
moritz authored
17 Building Rakudo
b4a3407 @pmichaud Typo reported by diakopter++: "prerequisits" -> "prerequisites".
pmichaud authored
18 See the INSTALL.txt file for detailed prerequisites and build and
90f996e @moritz move most of the build instructions into a separate INSTALL file
moritz authored
19 installation instructions. The short version is
20
0208b56 @pmichaud Refactor prerequisite notes, since INSTALL.TXT has the detailed
pmichaud authored
21 $ # recommended: install libicu-dev and libreadline-dev packages
652952a @colomon Add --gen-nqp to the Configure instructions.
colomon authored
22 $ perl Configure.pl --gen-parrot --gen-nqp
90f996e @moritz move most of the build instructions into a separate INSTALL file
moritz authored
23 $ make
24 $ make spectest # optional
25 $ make install # IMPORTANT, installs to install/bin/perl6
26
27 Note that the 'make install' step is necessary for running
28 Rakudo from outside the build directory. But don't worry, it
29 installs locally by default, so you don't need any administrator
30 privileges for carrying out this step.
fe29cde @coke README should be in text, not POD.
coke authored
31
32 Where to get help or answers to questions
33 There are several mailing lists, IRC channels, and wikis available with
34 help for Perl 6 and Rakudo on Parrot. Figuring out the right one to use
35 is often the biggest battle. Here are some rough guidelines:
36
b2e9a57 @pmichaud Update README.
pmichaud authored
37 The central hub for Perl 6 information is http://perl6.org/ .
38 This is always a good starting point.
39
fe29cde @coke README should be in text, not POD.
coke authored
40 If you have a question about Perl 6 syntax or the right way to approach
41 a problem using Perl 6, you probably want the "perl6-users@perl.org"
b2e9a57 @pmichaud Update README.
pmichaud authored
42 mailing list or the "irc.freenode.net/#perl6" channel. The perl6-users
43 list is primarily for the people who want to use Perl 6 to write
44 programs, so newbie questions are welcomed there. Newbie questions
45 are also welcome on the #perl6 channel; the Rakudo and Perl 6
46 development teams tend to hang out there and are generally glad
47 to help. You can follow "@rakudoperl" on Twitter, and there's
48 a Perl 6 news aggregator at <http://planetsix.perl.org> .
49
50 Questions about NQP can also be posted to the #perl6 IRC channel.
51 For questions about Parrot, see <http://parrot.org/> for links and
52 resources, or join the #parrot IRC channel on irc.perl.org .
fe29cde @coke README should be in text, not POD.
coke authored
53
54 Reporting bugs
55 Bug reports should be sent to "rakudobug@perl.org" with the moniker
56 [BUG] (including the brackets) at the start of the subject so that it
57 gets appropriately tagged in the RT system (https://rt.perl.org/rt3/).
58 Please include or attach any sample source code that exhibits the bug,
59 and include either the release name/date or the git commit identifier.
60 You find that information in the output from "perl6 --version" (or in
61 the first line of "git log", if Rakudo fails to build). There's no need
62 to cc: the perl6-compiler mailing list, as the RT system will handle
63 this on its own.
64
65 Submitting patches
66 If you have a patch that fixes a bug or adds a new feature, please
67 submit it to "rakudobug@perl.org" with the moniker [PATCH] (including
68 the brackets) at the start of the subject line. We'll generally accept
69 patches in any form if we can get them to work, but unified diff from
70 the "git" command is greatly preferred. In general this means that in
71 the "rakudo" directory you make your changes, and then type
72
73 git commit -m 'Your commit message' changed/filename.pm
74 git format-patch HEAD^
75
76 This will generate a file called "001-your-commit-message.patch", or
77 more of them if you made multiple commits; please attach these to your
78 email.
79
b2e9a57 @pmichaud Update README.
pmichaud authored
80 (Note to the maintainers: you can apply these patches with the
81 "git-am -s" command; it preserves meta information like author).
fe29cde @coke README should be in text, not POD.
coke authored
82
83 How the compiler works
84 See docs/compiler_overview.pod.
85
86 AUTHOR
b2e9a57 @pmichaud Update README.
pmichaud authored
87 Patrick Michaud "pmichaud@pobox.com" is the current pumpking for
88 Rakudo Perl 6. See CREDITS for the many people that have contributed
89 to the development of the Rakudo compiler.
Something went wrong with that request. Please try again.