Opened 16 years ago
Last modified 16 years ago
#144 closed enhancement
Beta test feedback - JA (1) — at Initial version
Reported by: | Dave Offiler | Owned by: | Dave Offiler |
---|---|---|---|
Priority: | normal | Milestone: | 2.0 |
Component: | ROPP (all) | Version: | 2.0beta |
Keywords: | tarballs, packaging, release files | Cc: | huw.lewis@… |
Description
Email from Josep Aparicio (Beta tester under VS contract) on Tue, 23 Sep 2008 14:56:22
Huw, Dave,
Although I am working on the internals of the code (mostly the forward operator), I have several things that I can suggest you now, and which would be easy for you to implement along the next few days. Essentially, the idea is that the presentation is confusing for an external user, and risks making it too puzzling to put it to use. I suggest you below how I would restructure it to make it look simpler.
-1) Restructure and simplify the deliverable:
For an external user, the structure of ROPP can be difficult to understand while browsing at the page, shortly after having gained access. It is thus preferable not to expose the users to the internals until later. Unless there is some reason that I am missing (copyright or similar), I would reduce the deliverable to one single file. The confused user will anyway download all files, then look inside, and still have some feeling that something may be missing. It is simpler to just have 1 file.
-2) Deliverable file:
Ideally the file's name should be ropp-n.m.tar.gz and develop to a subdirectory ropp-n.m The current "metafile" unpacks within the current directory (this is considered inappropriate). The modules can then be subdirectories, unpacked and uncompressed. It is ok to directly unpack all modules, even if the user ends up using only a fraction. Something like: ropp-n.m/README ropp-n.m/COPYRIGHT ropp-n.m/INSTALL ropp-n.m/grass_ropp_licence.pdf ropp-n.m/ropp_tools/ ... ropp-n.m/ropp_1dvar/ Again, the user is initially confused, so it is preferable at this stage to help the user to feel that everything is simple. It is ok to have a README file outside, but it is better to just say something like "download the tarball, unpack it, go to the main directory and read the INSTALL file".
-3) By the way, the current README is for version 1.2.
If the above steps are taken, the external README is much simpler. An internal README or INSTALL file, prominent upon unpacking will suffice.
-4) If you restructure things as above, upgrading may also be
easier for you, as only the upper tarball and directory have the version number.
Josep
-- Dr. Josep Maria APARICIO Data Assimilation and Satellite Meteorology Division Meteorological Service of Canada 2121 Transcanada Hwy H9P 1J3 Dorval, QC, Canada
Tel: 1-(514)-421-4687 Fax: 1-(514)-421-2106 Josep.Aparicio@…