Board index FlightGear Development Documentation

Readme file naming convention

Discussion of the FlightGear documentation, how it can be improved and coordination of people working on it.

Readme file naming convention

Postby macnab » Sat Feb 22, 2014 2:15 pm

Using a search for "readme" gives too many hits, so I don't know if this has been discussed before.

Is there a good reason for naming the files README.xxxxx instead of xxxxx.readme?
With the current convention, for each readme file that I want to read, I have to tell Windows which software to use to open the file, because every single file has a unique extension.

This is extremely irritating.
macnab
 
Posts: 886
Joined: Tue Aug 02, 2011 7:20 am
Location: Johannesburg, South Africa
Callsign: ZS-ILH
Version: Git
OS: Win7Pro 64bit SP1

Re: Readme file naming convention

Postby Hooray » Sat Feb 22, 2014 2:16 pm

it is irritating, mostly for Windows users - other OS don't just work in terms of file extensions ... but there's a PDF wrapper in $FG_ROOT/Docs that contains all files, and which can be searched easily
Please don't send support requests by PM, instead post your questions on the forum so that all users can contribute and benefit
Thanks & all the best,
Hooray
Help write next month's newsletter !
pui2canvas | MapStructure | Canvas Development | Programming resources
Hooray
 
Posts: 11321
Joined: Tue Mar 25, 2008 8:40 am

Re: Readme file naming convention

Postby macnab » Sat Feb 22, 2014 2:22 pm

Quickest response I've evr seen on this forum!!
And the PDF document even has an index, which makes life much easier. :D
macnab
 
Posts: 886
Joined: Tue Aug 02, 2011 7:20 am
Location: Johannesburg, South Africa
Callsign: ZS-ILH
Version: Git
OS: Win7Pro 64bit SP1

Re: Readme file naming convention

Postby Hooray » Sat Feb 22, 2014 2:26 pm

check the properties of the file first, it seems that it hasn't been updated during the last release cycle, so some of the plain text files may contain newer info - normally, there's a script that updates the file, but this is apparently not integrated with the release/build system and nobody ran the script either ...
Please don't send support requests by PM, instead post your questions on the forum so that all users can contribute and benefit
Thanks & all the best,
Hooray
Help write next month's newsletter !
pui2canvas | MapStructure | Canvas Development | Programming resources
Hooray
 
Posts: 11321
Joined: Tue Mar 25, 2008 8:40 am

Re: Readme file naming convention

Postby macnab » Sat Feb 22, 2014 2:29 pm

OK.

EDIT: It is dated 22/01/2014, and the first page says January 21st, 2014. Only 2 files have a date newer than that.
macnab
 
Posts: 886
Joined: Tue Aug 02, 2011 7:20 am
Location: Johannesburg, South Africa
Callsign: ZS-ILH
Version: Git
OS: Win7Pro 64bit SP1


Return to Documentation

Who is online

Users browsing this forum: No registered users and 0 guests