[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH] README: fix installation instructions
From: |
Mathieu Lirzin |
Subject: |
Re: [PATCH] README: fix installation instructions |
Date: |
Thu, 08 Feb 2018 23:53:35 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/25.3 (gnu/linux) |
Reuben Thomas <address@hidden> writes:
> INSTALL is a generated file (it comes from gnulib). It should not
> therefore be checked into git unless there's a really good
> reason. Note that it *should* be (and is!) distributed, so that when a
> user unpacks a distribution tarball, it will be there, ready to refer
> to.
>
> I suggest that README should make it more obvious that one needs to
> consult README-dev if building from git. But that's really the only
> change needed here.
I was mistakenly thinking that INSTALL was explaining what to do when
the configure script was not present (i.e. See ./README* files for
additional build instructions). But this is not the case and I am not
sure if it would be a good idea to do so.
As a consequence, I agree with your suggestion. What about something
like:
--8<---------------cut here---------------start------------->8--- See
See the file INSTALL for building and installation instructions. If
this file is not present, it means that you are using a development
repository so see README-dev for preliminary build instructions.
--8<---------------cut here---------------end--------------->8---
WDYT?
--
Mathieu Lirzin
GPG: F2A3 8D7E EB2B 6640 5761 070D 0ADE E100 9460 4D37
[PATCH v2 1/2] .gitignore: remove INSTALL from list, Christopher Diaz Riveros, 2018/02/08
[PATCH v2 2/2] INSTALL: New version, Christopher Diaz Riveros, 2018/02/08
[PATCH v2 0/2] Add INSTALL to hello project, Christopher Diaz Riveros, 2018/02/08