From: Benoit Daloze Date: 2011-01-21T19:19:47+09:00 Subject: [ruby-core:34718] Re: MRI file architecture doc On 21 January 2011 06:36, KOSAKI Motohiro wrote: >>> ------- README.FILES ------ >>> Explains the ruby project's file structure >>> (snip) >> >> This list includes generated files during build process. >> Such files should be separated. >> >> Additional to say, this list should be on Redmine wiki. >> On wiki, people who notice a new file or want more detail can add >> description. >> Fell free to ask the meaning of each files. >> We understand such document must be provided. > > Hmm.. > > I think svn is the best place. Why? Source files will be created and removed > with our development. So, the same time updating significantly keep to > consistency > with source. Especially, It can be easily maintained on multiple > version and/or branch. > > In other words, README.FILES is for extension developer. Not usualy > ruby programmer. > Then, we can assume they can extract source tarball and read included documents. > If false, Why do we include README.EXT in tarball? > > Thanks. I agree, README.FILES is about the project structure and you should be able to read it with the source. It is always nice to find files like misc/README, which is the 'README.FILES' of misc/. On 21 January 2011 09:03, NARUSE, Yui wrote: > This list includes files generated by tools provided by each systems. > We can't track or predict such files. > > Anyway main reason is because such documentation should be done by > external people. > Because only the people know what such people want the doc to have. But, yes, a wiki is easier to edit by external people. So, maybe a README.FILES reading "Please have a look at " ?