Organization

[AdamISZ]

I had a thought of organizing like this: for each different script, make a subdirectory; that way, a user can browse by clicking the subdir, and there can be a README that explains its function, which will show on the github webpage for easy reading of the description.

The top level README can explain the reason for the repo's existence and a simple instruction like 'you can copy script_name.py into your main joinmarket folder and run it'.

Just one possibility I guess.

[AlexCato]

Good idea to get some organization guidelines set up right away.

Because most scripts probably will only be one file, I'd prefer to group some of them together. E.g. all yield generators should be in the same directory, with one common readme (put one of these in your joinmarket-folder and run it) and an explanation of what this specific YG does in a big comment at the top of the YG file.

The same might or might not apply to other scripts, depending on what they are intending to do and how complex things become...

[raedah]

I think what AlexCato is saying makes sense.. because of the python include structure, most ygs will be stand alone and run from the top joinmarket directory. In the case where a yg was more then a single file, then putting its files in a directory for grouping would make sense.

[AdamISZ]

i wasn't suggesting separate directories for any architectural reason, only for the specific cosmetic reason i explained above.