From: Jan Nieuwenhuizen <janneke@gnu.org>
To: "Ludovic Courtès " <ludo@gnu.org>
Cc: guix-devel@gnu.org
Subject: Re: 02/04: doc: Update README to refer to the manual.
Date: Wed, 03 Jun 2020 11:23:46 +0200 [thread overview]
Message-ID: <87mu5k1p0d.fsf@gnu.org> (raw)
In-Reply-To: <20200602170006.4CE5220A26@vcs0.savannah.gnu.org> (guix-commits@gnu.org's message of "Tue, 2 Jun 2020 13:00:06 -0400 (EDT)")
Hi!
> 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.
> +If you are building Guix from source, please see the manual for build
> +instructions and requirements, either by running:
>
> - - [[https://gnu.org/software/guile/][GNU Guile 2.2.x]]
> - - [[https://notabug.org/cwebber/guile-gcrypt][Guile-Gcrypt]] 0.1.0 or later
> - - [[https://www.gnu.org/software/make/][GNU Make]]
> - - [[https://www.gnutls.org][GnuTLS]] compiled with guile support enabled
> - - [[https://notabug.org/guile-sqlite3/guile-sqlite3][Guile-SQLite3]], version 0.1.0 or later
> - - [[https://gitlab.com/guile-git/guile-git][Guile-Git]]
> - - [[http://www.zlib.net/][zlib]]
> - - [[https://savannah.nongnu.org/projects/guile-json/][Guile-JSON]]
> + info -f doc/guix.info "Requirements"
I can guess how the information in README is a duplication of what we have
in the maunual, and possibly even (somewhat) out of date, so for us as
developers/maintainers this means extra work...
> +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...
As an aside: what has always puzzled me is that GNU has failed/not
bothered yet to come up with some sort of standard file to list a
package's dependencies. If you're lucky, it's available in human
readable form README, or INSTALL, or ...
Sorry to be so grumpy ;)
Greetings,
Janneke
--
Jan Nieuwenhuizen <janneke@gnu.org> | GNU LilyPond http://lilypond.org
Freelance IT http://JoyofSource.com | Avatar® http://AvatarAcademy.com
next parent reply other threads:[~2020-06-03 9:23 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 ` Jan Nieuwenhuizen [this message]
2020-06-04 12:24 ` 02/04: doc: Update README to refer to the manual Ludovic Courtès
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87mu5k1p0d.fsf@gnu.org \
--to=janneke@gnu.org \
--cc=guix-devel@gnu.org \
--cc=ludo@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 external index
https://git.savannah.gnu.org/cgit/guix.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.