From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms11 with LMTPS id 8LdZJi9s114CIgAA0tVLHw (envelope-from ) for ; Wed, 03 Jun 2020 09:23:59 +0000 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2 with LMTPS id aMpBIi9s115ALwAAB5/wlQ (envelope-from ) for ; Wed, 03 Jun 2020 09:23:59 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 4EC309401D0 for ; Wed, 3 Jun 2020 09:23:59 +0000 (UTC) Received: from localhost ([::1]:33438 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jgPcs-0006zP-AS for larch@yhetil.org; Wed, 03 Jun 2020 05:23:58 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:47584) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jgPcj-0006z8-Le for guix-devel@gnu.org; Wed, 03 Jun 2020 05:23:49 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]:37752) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jgPcj-0006T6-CH; Wed, 03 Jun 2020 05:23:49 -0400 Received: from [2001:980:1b4f:1:42d2:832d:bb59:862] (port=39346 helo=dundal.peder.onsbrabantnet.nl) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1jgPci-0006F4-IT; Wed, 03 Jun 2020 05:23:48 -0400 From: Jan Nieuwenhuizen To: =?utf-8?Q?Ludovic_Court=C3=A8s=20?= Subject: Re: 02/04: doc: Update README to refer to the manual. Organization: AvatarAcademy.nl References: <20200602170004.20721.34450@vcs0.savannah.gnu.org> <20200602170006.4CE5220A26@vcs0.savannah.gnu.org> X-Url: http://AvatarAcademy.nl Date: Wed, 03 Jun 2020 11:23:46 +0200 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)") Message-ID: <87mu5k1p0d.fsf@gnu.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.3 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-BeenThere: guix-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: guix-devel@gnu.org Errors-To: guix-devel-bounces+larch=yhetil.org@gnu.org Sender: "Guix-devel" X-Scanner: scn0 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of guix-devel-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-devel-bounces@gnu.org X-Spam-Score: -1.01 X-TUID: Mi6vbYTv84pl Hi! > commit c75a80189fc19f6ff8b4c82d1d1801be6763b6d2 > Author: Ludovic Court=C3=A8s > 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: >=20=20 > - - [[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 enabl= ed > - - [[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/Installati= on.html][web copy of the manual]]. >=20=20 > For information on installation from a Git checkout, please see the sect= ion > "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 --=20 Jan Nieuwenhuizen | GNU LilyPond http://lilypond.org Freelance IT http://JoyofSource.com | Avatar=C2=AE http://AvatarAcademy.com