From 3b2c76c66bab81c5fc14dc5396b643504ab818dc Mon Sep 17 00:00:00 2001 From: pmichaud Date: Wed, 28 Jul 2010 02:05:26 -0500 Subject: Add README, docs/CREDITS. --- skel/README | 150 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 150 insertions(+) create mode 100644 skel/README (limited to 'skel/README') diff --git a/skel/README b/skel/README new file mode 100644 index 0000000..0741701 --- /dev/null +++ b/skel/README @@ -0,0 +1,150 @@ +This is Rakudo Star, a useful, usable Perl 6 distribution for "early adopters". + +Rakudo Star is Copyright (C) 2010 by the Rakudo Star Team. + +License Information + +Rakudo Star is distributed under the terms of the Artistic License 2.0. +This distribution contains software collected from other sources; see the +individual source subdirectories (in parrot/, rakudo/, and modules/) for +copyright and licensing information of those components. + + +Build Prerequisites + +To build Rakudo Star you need at least a C copmiler, a 'make' utility, +and Perl 5.8 or newer. + +In order to fully support Unicode, you'll also want to have the +ICU library installed (http://site.icu-project.org/). +Rakudo can run without ICU, but some Unicode-related features +do not work properly. + +On Debian GNU/Linux or Ubuntu Linux, the necessary components +for building Rakudo can be installed via the command. + +As an example, on Debian GNU/Linux or Ubuntu Linux, the necessary +components for building Rakudo can be installed via the command + + aptitude install build-essential libicu-dev subversion + +Readline support also requires the "libreadline5-dev" library. + + +Building Rakudo Star + +The basic steps to build Rakudo Star are: + + $ perl Configure.pl --gen-parrot + $ make + $ make install + +This will build a Perl 6 executable and install selected +Perl 6 modules in the install/ subdirectory. Programs can +then be run directly using a command like: + + $ ./perl6 hello.pl + +Programs can also be run by adding the "install/bin" directory +to your PATH environment variable. + +The "--gen-parrot" option above tells Configure.pl to automatically +build and install the version of Parrot that is distributed with +Rakudo Star. The "--prefix=" option can be provided to Configure.pl +to change the location of the install directory. + +If your system already has an installed Parrot, Configure.pl will +look for "parrot_config" in your execution PATH, or the location +of parrot_config can be explicitly provided to Configure.pl via +the "--parrot_config" option: + + $ perl Configure.pl --parrot-config=/path/to/bin/parrot_config + +If the Rakudo compiler is invoked without an explicit script to +run, it enters a small interactive mode that allows Perl 6 statements +to be executed from the command line. + + +Running the Perl 6 test suite + +Entering "make rakudo-test" will run a small test suite that comes +bundled with Rakudo. This is a simple suite of tests, designed +to make sure that the Rakudo compiler is basically working and that +it's capable of running a simple test harness. + +Running "make spectest" in the rakudo/ subdirectory will import +the official Perl 6 test suite from the Pugs repository +(http://svn.pugscode.org/pugs/t/spec/) and run all of these tests +that are currently known to pass. + +If you want to automatically submit the results of your spectest run +to a central server, use 'make spectest_smolder' instead. You need +the Perl 5 module 'TAP::Harness::Archive' and an active internet +connection for that. The smoke results are collected at +http://smolder.plusthree.com/app/public_projects/details/18. + +For more details about running tests, see rakudo/README . + + +Where to get help or answers to questions + +The http://perl6.org/ website contains a great many links to +resources for Perl 6 development, and is generally the starting +point for information about Perl 6. + +There are several mailing lists, IRC channels, and wikis available +with help for Perl 6 and Rakudo on Parrot. Figuring out the right +one to use is often the biggest battle. Here are some rough +guidelines: + +If you have a question about Perl 6 syntax or the right way to +approach a problem using Perl 6, you probably want the +perl6-users@perl.org mailing list. This list is primarily +for the people who want to use Perl 6 to write programs, as +opposed to those who are implementing or developing the Perl 6 +language itself. + +Questions about the Rakudo compiler for Parrot and the Parrot compiler +tools can go to perl6-compiler@perl.org. Discussion about Parrot itself +generally takes place on parrot-dev@lists.parrot.org. + +The Rakudo and Parrot development teams tend to hang out on IRC a fair +bit, either on irc.freenode.net/#perl6 or irc.perl.org/#parrot. + +Rakudo's official web site is http://rakudo.org/ , where you can +find useful information for developers and users alike. + + +Reporting bugs + +Bug reports about Rakudo Star or the Perl 6 specification should be +sent to rakudobug@perl.org with the moniker [BUG] (including the brackets) +at the start of the subject so that it gets appropriately tagged in the +RT system (https://rt.perl.org/rt3/). Please include or attach any sample +source code that exhibits the bug, and include either the release name/date +or the git commit identifier. You find that information in the output from +"perl6 --version". There's no need to Cc: the perl6-compiler +mailing list, as the RT system will handle this on its own. + + +Submitting patches + +Patches to the Rakudo compiler itself should be submitted to +'rakudobug@perl.org'. Patches for individual modules should be +submitted to the module authors (see the module source code for +details). + +We'll generally accept patches in any form if we can get them to work, +but unified diff from the 'git' command is greatly preferred. +See further instructions in the rakudo/ subdirectory for more details. +Other ways to create and submit patches are discussed at +http://wiki.github.com/rakudo/rakudo/steps-to-create-a-patch. + +=head1 AUTHOR + +Patrick Michaud (pmichaud@pobox.com) is the primary author and +maintainer for Rakudo Star. See CREDITS for further authors. + +=cut + +## vim: expandtab sw=4 ft=pod tw=70: -- cgit v1.1