View Single Post
Old 03-05-10, 11:27 AM   #5
BillyBubble
Watch
 
Join Date: Apr 2005
Posts: 22
Downloads: 331
Uploads: 0
Default

Thanks for the reminder, Piri !
Have noted the readmes spreading around every here and now for myself

However, to my knowledge JSGME neither assumes nor defaults to a "documentation" folder by itself. This has become habit and tradition for SH mods afaik, and it is a good one for sure I think.
OTOH things change over time which also gives us chances and room to improve further:

SH5 already includes a new folder called "support".

In my first SH5 mod I took this opportunity and used that one to create a new "mods" subfolder with another one inside containing the name of the mod itself.
Inside this "xxx_mod" folder all documentation could take place, at least this is what I think.

Given that, if you folks dont mind, let me propose a new mod documentation structure, similar to the existing one (since SH3) but adopting then new stucture this way:

XXX_Mod\data
XXX_Mod\support\mods\XXX_Mod

What do guys think ?


EDIT:
ddrgn, all: using the above structure no mod readmes ever would conflict OR are restricted in naming or numbers as each mod has its own doc/support subfolder.

EDIT:
ok disgerad my proposal please (cant strike out text passages, sorry)
Due to some JSGME features i think its better to stick with the OPs suggestion.

Last edited by BillyBubble; 03-05-10 at 01:26 PM.
BillyBubble is offline   Reply With Quote