This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Clarify side-by-side checkouts.
authorJames E Keenan <jkeenan@cpan.org>
Fri, 13 Oct 2017 10:25:56 +0000 (12:25 +0200)
committerJames E Keenan <jkeenan@cpan.org>
Fri, 13 Oct 2017 10:25:56 +0000 (12:25 +0200)
README

diff --git a/README b/README
index 459f048..eaa65e1 100644 (file)
--- a/README
+++ b/README
@@ -14,10 +14,16 @@ You have presumably obtained the metaconfig from the repository e.g.
 
   $ git clone github.com:perl5-metaconfig/metaconfig metaconfig
 
-Normally this directory and perl directory are next to each other
-so ../perl will get you to perl and ../perl/../metaconfig will get you
-back here. The current setup will require a symbolic link to the folder
-where Configure is generated in:
+When working with metaconfig you will generally have two git checkouts
+next to each other:  (1) this metaconfig checkout; and (2) a checkout of
+the Perl 5 source code in which you will generate a new Configure
+script. In this README, we will refer to these directories as the
+'metaconfig' directory and the 'perl' directory.
+
+Since these two directories are normally next to each other, so ../perl
+will get you to perl and ../perl/../metaconfig will get you back here.
+You should establish a symbolic link to the checkout in which Configure
+is generated such as this:
 
   $ cd metaconfig
   $ ln -s ../perl perl