From: "Ludovic Courtès" <ludo@gnu.org>
To: Jan Nieuwenhuizen <janneke@gnu.org>
Cc: guix-devel@gnu.org
Subject: Re: 02/04: doc: Update README to refer to the manual.
Date: Thu, 04 Jun 2020 14:24:40 +0200 [thread overview]
Message-ID: <87d06fauif.fsf@gnu.org> (raw)
In-Reply-To: <87mu5k1p0d.fsf@gnu.org> (Jan Nieuwenhuizen's message of "Wed, 03 Jun 2020 11:23:46 +0200")
Hello! :-)
Jan Nieuwenhuizen <janneke@gnu.org> skribis:
>> commit c75a80189fc19f6ff8b4c82d1d1801be6763b6d2
>> Author: Ludovic Courtès <ludo@gnu.org>
>> AuthorDate: Tue Jun 2 14:50:54 2020 +0200
>>
>> doc: Update README to refer to the manual.
>>
>> * README (Requirements): Refer to the manual.
>> (Installation): Update URL of the manual.
>
> Hmm, I don't like it! Also, no rationale.
Someone reported that the list of dependencies (the Guile version in
particular) in ‘README’ was outdated. I set out to update it and then
realized that that info was already available and up-to-date in the
manual. Hence this patch.
>> +or by checking the [[https://guix.gnu.org/manual/en/html_node/Installation.html][web copy of the manual]].
>>
>> For information on installation from a Git checkout, please see the section
>> "Building from Git" in the manual.
>
> ...but as a new potential user of a software I have often cursed the
> makers for providing "empty" READMEs that refer to documentation that is
> neither built (yet) or shipped, or needs a viewer/web browser; making it
> most convenient for them, the writers, and not for me, the reader;
> leaving me puzzled ... "So, you'd rather not have me use your software?"
>
> I'm wondering if you haven't had that experience, and how you look at
> this...
Sure. Two things:
1. People installing a release from a tarball have doc/guix.info
already built.
2. The ‘README’ also gives the URL of the on-line copy of the manual.
So I think the information is readily available.
My goal here was just to avoid having an outdated copy of parts of the
manual.
I hope that makes sense!
Ludo’.
next prev parent reply other threads:[~2020-06-04 12:24 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20200602170004.20721.34450@vcs0.savannah.gnu.org>
[not found] ` <20200602170006.4CE5220A26@vcs0.savannah.gnu.org>
2020-06-03 9:23 ` 02/04: doc: Update README to refer to the manual Jan Nieuwenhuizen
2020-06-04 12:24 ` Ludovic Courtès [this message]
2020-06-04 19:30 ` Jan Nieuwenhuizen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87d06fauif.fsf@gnu.org \
--to=ludo@gnu.org \
--cc=guix-devel@gnu.org \
--cc=janneke@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).