[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH] README: fix installation instructions

From: Reuben Thomas
Subject: Re: [PATCH] README: fix installation instructions
Date: Thu, 8 Feb 2018 21:57:55 +0000

On 8 February 2018 at 16:57, Mathieu Lirzin <address@hidden> wrote:

> Hello,
> Christopher Diaz Riveros <address@hidden> writes:
> > Installation and building instructions point to INSTALL file, which is
> > ignored in .gitignore. Given the fact that Installation and building
> > process is already covered in README-dev, changing the instruction in
> > README seems more reasonable than creating an INSTALL file and removing
> > it from .gitignore.
> referencing INSTALL from README is part of GNU Coding Standards, so
> INSTALL should simply be checked in.  README-dev is for developpers not
> “regular” users.  Since GNU Hello is intended as an example package it
> shouldn't deviate from GCS.

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.


reply via email to

[Prev in Thread] Current Thread [Next in Thread]