[microsound] Project folder organisation and conventions

[Paulo Mouat <paulo.mouat@xxxxxxxxx>]

All,

A few notes on the file organisation in the repository for current or
future projects (I just finished most of these changes for the past
projects):
- Keep nested folders to a minimum. This will improve navigability and
avoid unnecessary clicking when checking out several files in a given
project. To accomplish this, I ask that we stop using the drop box
concept or any derivatives (e.g. folders named after the
contributors). Project file structure should be as flat as possible.
- Main sound/media files should be named "artist name - track
name.extension", so that attribution is clear from the name and allows
the flat list of files. Standardizing on such a naming scheme will
allow future enhancements by making the names easily parsable through
scripting.
- When adding notes, I suggest a single notes file named similarly to
the media file (e.g. "artist name - track name.txt"). These files
could either be placed alongside the media files or inside a "notes"
folder for the entire project. I believe the latter option to be
cleaner--thoughts?
- If there are many files associated with the main sound files that
project contributors deem useful to be shared, I suggest a folder
named e.g. "associated files" for the entire project, where
contributors can then create folders with their names and dump the
content inside in whatever structure they wish (anything goes here).
- In general, avoid Mac/PC/Linux-specific files (e.g. .sit/.hqx/.exe
files). If you want to compress files, use a format that is common to
all platforms. The same reasoning applies to media and document files.
Executables are obviously platform-specific, so unless there is a very
good reason to add executables to the repository, please refrain from
doing so (the repository is not an application warehouse).

Hopefully, by following these simple conventions the job of
maintaining and managing the repository will be greatly simplified. In
any case, feedback is welcome to improve any of the guidelines above.

//p
http://www.interdisciplina.org/00.0/

---------------------------------------------------------------------
To unsubscribe, e-mail: microsound-unsubscribe@xxxxxxxxxxxxx
For additional commands, e-mail: microsound-help@xxxxxxxxxxxxx
website: http://www.microsound.org