summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdam Spiers <stow@adamspiers.org>2017-03-19 21:12:46 +0000
committerAdam Spiers <stow@adamspiers.org>2017-03-19 21:12:46 +0000
commit655e8e4a3d9a6b00e0edb4b5df8674307ad0074b (patch)
tree5a9e85550b80cc91256d8ef05a8e763b94a77097
parentea11f266a57bea96dc0728284ad9d2d85aeaa0d2 (diff)
downloadstow-655e8e4a3d9a6b00e0edb4b5df8674307ad0074b.tar.gz
INSTALL.md: document how to build from git (#20)
Fixes https://github.com/aspiers/stow/issues/20
-rw-r--r--INSTALL.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md
index f962755..eb80171 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -32,6 +32,26 @@ Advantages of the `Module::Build` approach:
- It performs dependency checking to ensure you have the necessary
Perl modules installed.
+Both approaches are described in detail below. However if you are
+building from the git repository rather than an official release,
+you first need to perform some extra steps:
+
+Preparatory steps required only when building from git
+------------------------------------------------------
+
+`configure` and `Makefile` are included in official releases of Stow,
+but they are deliberately omitted from the git repository because they
+are autogenerated. Therefore if you are installing directly from git,
+you first need to generate them as follows.
+
+First `cd` to the directory containing the source code (and this
+file), and then run:
+
+ autoreconf -iv
+
+If this runs successfully then you are ready to continue with one of
+the two installation methods below.
+
Basic Installation via `Module::Build`
--------------------------------------