[MITgcm-devel] to readme or not to readme

[Jean-Michel Campin]

Hi Martin,

ocean.mit.edu was down for a while, and I just get acces to my mail box again.

I don't think it's useless to have an up-to-date README file
for each experiment.
I recently updated global_ocean.cs32x15/README, but I would not
claim that "this is a good example of what a README file should be".
But I aggree with you. I would propose that, if there are some
matlab scripts in some dir, this could be mentionned.

Cheers,

Jean-Michel

> Hi,
> I just noticed (or rather was reminded by having a closer look at 
> "them") that many of the README files in the verification experiments 
> have either little to do with the actual content of the directories or 
> the instruction in how to build the model are outdated:
> verification/README (incomplete list)
> verification/aim.5l_LatLon/README
> verification/exp0/README
> verification/exp1/README
> verification/exp3/README
> verification/exp4/README
> verification/exp5/README
> verification/flt_example/README
> verification/front_relax/README
> verification/global_ocean.90x40x15/README
> verification/global_ocean.cubed32x32x30/README
> verification/global_ocean_pressure/README
> verification/hs94.1x64x5/README
> verification/internal_wave/README
> verification/inverted_barometer/README
> verification/natl_box/README
> 
> Some of the README's belong to experiments, that are no longer tested. 
> For some of the README's I am actually responsible myself, but before I 
> update those, is there a general idea of what should be contained in 
> them (i.e.., a good example of what a README should look like)? I guess 
> compile instructions can be found on the manual-web pages and should 
> therefore not be repeated in every directory? I personally feel, that 
> is it more important to describe, what is actually happening in the 
> specific experiment.
> 
> Martin
> 
> 
> 
> 
> _______________________________________________
> MITgcm-devel mailing list
> MITgcm-devel at mitgcm.org
> http://mitgcm.org/mailman/listinfo/mitgcm-devel