[Top][All Lists]

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

Re: doc vs. README

From: Bruno Haible
Subject: Re: doc vs. README
Date: Thu, 10 Dec 2009 12:07:13 +0100
User-agent: KMail/1.9.9

Hi Karl,

>     *** README.orig   2009-12-09 20:16:50.000000000 +0100
>     --- README        2009-12-09 19:36:18.000000000 +0100
> How about adding everything in README to gnulib.texi, and generating it?
> The README grows and grows, in both length and importance ...

Yes, you are right. 2/3 of gnulib's README is a section "Contributing to
gnulib", which could become a chapter of the published gnulib documentation.

Also, I nowadays tend to prefer to read HTML formatted documentation,
over plain text documentation,
  1. because it's structured and allows me to find easily what I'm looking for,
  2. because a proportional font is a little bit easier to read.

On the other hand, since it takes 10 minutes each time to regenerate the doc
on the web, there is also the need to have the most immediate information
directly accessible in a README. But that could be limited to the first 75
lines of its current contents.


reply via email to

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