search

matthewscharles / instrument-maker

A framework for making digital instruments with sensors, driven by a need to improve access.
http://www.instrumentmaker.org/
GNU General Public License v3.0
18 stars 5 forks source link

Declutter main folder and identify/signpost main documentation #27

Open alexmlucas opened 4 years ago

alexmlucas commented 4 years ago

For easy access, it would be great if key documentation such as im-current-objects.pd was at the top tier of the instrument-maker folder hierarchy. There's a great deal of content in the top-level folder, could some of these files be placed in subfolders?

matthewscharles commented 4 years ago

That's putting it mildly!

Yes documentation patch to top level, I need to check the .md files for any tutorials that are linked in the web version.

learning-pd-through-im.md is currently the main document - might need to split this into smaller files, so having a clear structure will be essential

Not sure about moving the objects and help files into a subfolder -- or at least, all the objects will need to be in the same subfolder until I can get authorisation to upload this to Deken. I'll look at some restructuring in the morning.

matthewscharles commented 4 years ago

need to decide on function of learning-examples folder, probably rename.

if any of these might be useful for the nime workshop, I'm happy to start adapting and/or expanding.

im.reference can probably go for now (I was generating this html and pd help files from a central node.js script, but the JSON information was horrible to update so they're back to manual at the moment).

matthewscharles commented 4 years ago

I'm trying a new folder out here (if you clone this branch, add im.objects to your search path):

https://github.com/matthewscharles/instrument-maker/tree/restructure

If nothing else, it's helping get a sense for how that main folder looks from the outside. It'll be difficult to go back from this. Hoping to put some decent hours in this week.