Description
*) For each new example, one would need to update the top-level README, then add a new directory containing an init, the .py file, and also it's own README describing what the script is, and why and how to use it. Is that correct? Is there some easier way to do this?
*) For the existing file, gaussianfit, the README is missing some critical information… (1) what do I need to install first to make it work? (2) how do I install the script itself? (see below) and again, (3) tell me why and not what.
Usage in IPython shell:
Install this extension with
%install_ext https://raw.github.com/diffpy/srfit-demos/master/ipyplugin/gaussianfit.py
Activate this extension using
%load_ext gaussianfit
*) The CMI_scripts page is a little better, but the lower level pages for each script need some more content. If you expect people to add meaningful content to the README file, you have to demonstrate it yourself in the existing examples -- as a template. What I'd suggest is to write the top-level module doc for the file, and then use most of that for the README. Same comments (1), (2), and (3) above.