aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorSteve Mynott <steve.mynott@gmail.com>2017-07-06 15:54:12 +0100
committerSteve Mynott <steve.mynott@gmail.com>2017-07-06 15:54:12 +0100
commitf0d3c5f8c3cf148a4ea9b0c1f0f61961c00d22a5 (patch)
tree0dabc3ec14b0de6efd161bc799155e911f3a16ba /README
parent17634af46dd4577dc1217848145204be1662b862 (diff)
Correct $INSTDIR path documention and move to new section.
Mention the second PATH addition and remind user the source build will display this anyway
Diffstat (limited to 'README')
-rw-r--r--README38
1 files changed, 26 insertions, 12 deletions
diff --git a/README b/README
index a26be11..0e9541a 100644
--- a/README
+++ b/README
@@ -81,18 +81,6 @@ After configuration, build Rakudo Star on a UNIX-like system with:
$ make
$ make install
-Once Rakudo Star is installed, you can run Perl 6 programs by doing:
-
- $ ./perl6 hello.pl
-
-Programs can also be run by adding the local "install/bin" directory or
-system-wide "$INSTDIR" directory (if you used the --prefix option) to
-your PATH environment variable.
-
-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.
-
Rakudo Star can be built on Windows either using Microsoft tools (MSVC) and
nmake or using gcc and gmake as bundled with Strawberry Perl. In the latter
case use cmd.exe rather than bash as a shell.
@@ -100,6 +88,32 @@ case use cmd.exe rather than bash as a shell.
Note that possible platform-specific errata may be covered under:
https://perl6.org/downloads/
+Setting up the environment
+--------------------------
+To set up the environment under a UNIX type system you will need to add the
+absolute path of the local "install/bin" directory under your source build
+directory or system-wide "${INSTDIR}/bin" directory (if you used the
+--prefix option) to your PATH environment variable.
+
+Note also that other executable scripts such as "p6doc" will be installed
+under "${INSTDIR}/share/perl6/site/bin" so you also need to add that to the
+PATH for development convenience.
+
+You will have to append the %PATH% in a similar way under Windows. You
+may have to use Windows type directory path separators.
+
+You will be reminded of the two additions to the PATH by a welcome message
+after the source build completes.
+
+Once Rakudo Star is installed (and assuming perl6 is in your PATH), you can
+run Perl 6 programs by doing:
+
+ $ perl6 hello.pl
+
+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
-----------------------------