[GNC-dev] README Overview; was: Gnome HIG

[David T.]

And if we’re going there, the main project includes numerous README files in gnucash/doc, all of which need similar treatment. README files for WIN32, HCBI and OFX should IMHO be removed altogether in favor of other venues (didn’t HBCI get replaced by FinTS in, like, 2002?).

David

> On Sep 15, 2018, at 1:21 PM, David T. <sunfish62 at yahoo.com> wrote:
> 
> 
> 
>> On Sep 15, 2018, at 12:55 PM, David T. via gnucash-devel <gnucash-devel at gnucash.org> wrote:
>> 
>> 
>> 
>>> On Sep 15, 2018, at 5:29 AM, Frank H. Ellenberger <frank.h.ellenberger at gmail.com> wrote:
>>> 
>>> As we are already there,
>>> 
>>> one of you Davids might also review
>>> https://github.com/Gnucash/gnucash/blob/maint/README section overview,
>>> 
>>> and probably  files in
>>> https://github.com/Gnucash/gnucash/tree/maint/doc
>>> https://github.com/Gnucash/gnucash-docs/blob/maint/gnucash-docs.spec.in
>>> ...
>>> which borrow the intro
>>> 
>>> There have been "shiny new features" of 1.x which no one any longer
>>> would mention for the 3.x series.
>>> 
>> 
>> Honestly, I think the text in the README would more accurately reflect John’s concerns about the breathless tone found in the Guide, and so I am more likely to put *that* text into the Guide, rather go the other way. 
>> 
>> Furthermore, in the interest of eliminating bit rot and in using the right tool for the right job, I would strip the README back drastically to cover only basic technical details on downloading, installing, and running GnuCash. Everything else should go, IMHO.
>> 
>> David
>> 
> 
> To be specific: in the main README, I would eliminate the Overview altogether, and replace it with:
> 
> GnuCash is a double entry personal and small business financial management package.
> 
> Home Page:
> http://www.gnucash.org/
> 
> Precompiled binaries:
> http://www.gnucash.org/download
> 
> That is it.
> 
> All the remaining sections should be altered to refer readers to the fuller and more up-to-date information as it resides elsewhere (most notably, on the wiki or website).
> 
>> _______________________________________________
>> gnucash-devel mailing list
>> gnucash-devel at gnucash.org
>> https://lists.gnucash.org/mailman/listinfo/gnucash-devel
>