README issues

README issues

[Jean-Christophe Helary]

[-- Attachment #1: Type: text/plain, Size: 381 bytes --]

Good evening everybody, thank you for helping on the IRC channel.

Here is a README patch to minimally document fixes for the issues I had.

Don't hesitate to edit to follow the guile documentation standards of any.

If there is a need to have a FSF disclaimer, I'm OK with that. Let me know how to do that (I already have one for emacs/texinfo/translation in general).



[-- Attachment #2: README.diff --]
[-- Type: application/octet-stream, Size: 2913 bytes --]

diff --git a/README b/README
index 68c02519e..231184411 100644
--- a/README
+++ b/README
@@ -1,8 +1,8 @@
-This is a prerelease of version 3.0 of Guile, Project GNU's extension
-language library.  Guile is an implementation of the Scheme programming
-language, packaged as a library that can be linked into applications to
-give them their own extension language.  Guile supports other languages
-as well, giving users of Guile-based applications a choice of languages.
+This is version 3.0 of Guile, Project GNU's extension language library.
+Guile is an implementation of the Scheme programming language, packaged
+as a library that can be linked into applications to give them their own
+extension language.  Guile supports other languages as well, giving
+users of Guile-based applications a choice of languages.
 
 Please send bug reports to bug-guile@gnu.org.
 
@@ -10,14 +10,28 @@ See the LICENSE file for the specific terms that apply to Guile.  Note
 that for any copyright year range specified as YYYY-ZZZZ in this
 package, the range specifies every single year in that closed interval.
 
+In the beginning ==========================================================
 
-Additional INSTALL instructions ===========================================
+Run ./autogen.sh to generate the INSTALL file if it is not present.
 
-Generic instructions for configuring and compiling Guile can be found
-in the INSTALL file.  Guile specific information and configure options
-can be found below, including instructions for installing SLIB.
+You will need a number of up-to-date packages, including:
+
+autoconf (GNU Autoconf)
+automake (GNU automake)
+glibtoolize (GNU libtool)
+sed (GNU sed)
+GNU M4
+flex
+gettext
+
+If for some reason you have error messages about a "possibly undefined
+macro" when you are sure the macros are installed, make sure that the
+automake/v.e.r.s.i.o.n/share/aclocal/dirlist contains the path to those
+macros.
+
+Once ./autogen.sh exits properly you can run ./configure and then make.
 
-Guile depends on the following external libraries.
+Note that guile also depends on the following external libraries.
 - libgmp
 - libiconv
 - libintl
@@ -25,7 +39,16 @@ Guile depends on the following external libraries.
 - libunistring
 - libgc
 - libffi
-It will also use the libreadline library if it is available.
+
+If you have issues with readline (and you'll only know after make has
+done a huge lot), use configure with the --with-libreadline-prefix
+option.
+
+Additional INSTALL instructions ===========================================
+
+Generic instructions for configuring and compiling Guile can be found
+in the INSTALL file.  Guile specific information and configure options
+can be found below, including instructions for installing SLIB.
 
 There is a corresponding `--with-XXX-prefix' option for each of these
 libraries (except for libgc and libffi which use `pkg-config', see

[-- Attachment #3: Type: text/plain, Size: 122 bytes --]


Jean-Christophe Helary
-----------------------------------------------
http://mac4translators.blogspot.com @brandelune

Re: README issues

[Ludovic Courtès]

Hello,

Jean-Christophe Helary <jean.christophe.helary@traduction-libre.org>
skribis:

> Good evening everybody, thank you for helping on the IRC channel.
>
> Here is a README patch to minimally document fixes for the issues I had.
>
> Don't hesitate to edit to follow the guile documentation standards of any.
>
> If there is a need to have a FSF disclaimer, I'm OK with that. Let me know how to do that (I already have one for emacs/texinfo/translation in general).

I pushed something similar to what you proposed (slightly less
detailed).  Thank you for the patch!

Ludo’.

Re: README issues

[Jean-Christophe Helary]

Thank you Ludovic !

> On Mar 8, 2020, at 0:59, Ludovic Courtès <ludo@gnu.org> wrote:
> 
> Hello,
> 
> Jean-Christophe Helary <jean.christophe.helary@traduction-libre.org>
> skribis:
> 
>> Good evening everybody, thank you for helping on the IRC channel.
>> 
>> Here is a README patch to minimally document fixes for the issues I had.
>> 
>> Don't hesitate to edit to follow the guile documentation standards of any.
>> 
>> If there is a need to have a FSF disclaimer, I'm OK with that. Let me know how to do that (I already have one for emacs/texinfo/translation in general).
> 
> I pushed something similar to what you proposed (slightly less
> detailed).  Thank you for the patch!
> 
> Ludo’.

Jean-Christophe Helary
-----------------------------------------------
http://mac4translators.blogspot.com @brandelune