Complete.Org: Mailing Lists: Archives: freeciv-dev: January 2002:
[Freeciv-Dev] Re: Irritatingly long file names
Home

[Freeciv-Dev] Re: Irritatingly long file names

[Top] [All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index] [Thread Index]
To: <freeciv-dev@xxxxxxxxxxx>
Subject: [Freeciv-Dev] Re: Irritatingly long file names
From: "Per I. Mathisen" <Per.Inge.Mathisen@xxxxxxxxxxx>
Date: Thu, 17 Jan 2002 08:52:57 +0100 (MET)

On Thu, 17 Jan 2002, Vasco Alexandre Da Silva Costa wrote:
> Well like Christian suggested there are other possible names:
>  README.code
>
> and i have this brand spanking new one here:
>  README.indent

Neither are as explanatory as README.coding_style, I'm afraid. But why add
README, anyway? It is not like it is something ordinary players should
read (which is implied by "README"). Could just call it CODING_STYLE.

> I just sugested README.style because, well, it seemed like a good idea at
> the time, with the header of that file having " Freeciv Style Guide" in it
> et all.

Could be misunderstood for "playing style", you know. I can imagine some
very confused newbies trying to figure out that document ;)

> How about the 'freeciv_hackers_guide.txt' does everyone agree with the superb
> README.hacking name suggested by Jason?

It is better, but I don't really like to prefix it with README. Perhaps we
can create a new directory docs/ for documents that only programmers are
meant to read? coding_style.text and hackers_guide.text (my suggestions
for names) would go in there in the begining. the hackers_guide should
also be split up into multiple files for better readability.

Yours,
Per

"What we anticipate seldom occurs: but what we least expect generally
happens." -- Benjamin Disraeli




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