CNMAT-OM Folder Name

[mattschumaker]

The name of the CNMAT Openmusic library is "CNMAT-OM". However, when it is downloaded from github, it becomes "CNMAT-OM-master." Is there a way to get rid of the "master" in the folder name so that the downloaded folder simply reads "CNMAT-OM"? @equilet

[EdmundCampion]

assigning to Jeff for comment

[equilet]

no. If you make a release, the tag will be appended to the relevant download. Have you experimented with this?

[mattschumaker]

I just downloaded the library from github after Ed pointed out that the folder comes out with "master" appended to it. Is there anything further to experiment with there?

Could we put all of the materials into a further subfolder called CNMAT-OM? This way, when downloaded, you would receive a folder called "CNMAT-OM-master" , inside which is the folder "CNMAT-OM" with all the materials in it and that you can then simply load into OM-Library folder in your Documents folder?

[equilet]

Let's talk about this over the phone; it's not complicated, but you need to do more than downloading the library from Github at the main download link.

[mattschumaker]

Thank you. That sounds great. I'll email you to set a time.

[j-bresson]

Hi there ! A good thing to do when releasing an OM library is to append the version number after the main folder name (e.g. "CNMAT-OM 1.0"). This is how OM (and users) know if this is the last release etc. So it might be interesting to consider a specific download archive zipped and uploaded manually from tagged versions.

[equilet]

I believe this comes naturally if @mattschumaker follows my master plan of using tagged releases.

[j-bresson]

yes, the only issue will be that the downloaded folder will be named "CNMAT-OM-1.0", instead of "CNMAT-OM 1.0"... The space separates the core name and the version number.

[equilet]

I see. Thanks for including that detail.

[j-bresson]

by the way, if the lib will be called OM-Tessellate, it might be worth reorganizing the repository and making it a subdirectory of CNMAT-OM. This would allow for addition of some other libs in the future.

[mattschumaker]

Yes, conceptually, CNMAT-OM is the master library and Tessellate is a subdirectory of that.

If you mean that we should further subcategorize the source code and other library documents, then I can check here: http://repmus.ircam.fr/openmusic/dev-resources/userlib or ask you for guidance?

There already is some differentiation between Tessellate and CNMAT-OM. Functions for Tessellate are currently in their own subdirectory of CNMAT-OM, accessible in a patch under: /Functions/Libraries/CNMAT-OM/Tessellate/

Whereas, tutorial patches for Tessellate are currently downloaded by selecting to receive all of CNMAT-OM tutorials under: /Help/Import Tutorial Patches/ Libraries/CNMAT-OM

[equilet]

@j-bresson - do you think this presents a reason to use GIT sub-modules?

[j-bresson]

I'm not really sure what would be the advantages of this.

[mattschumaker]

When it is downloaded as an OM library, Tessellate can be: a) its own library in its own folder, or b) a sub-folder of a larger library called CNMAT-OM.

Of the two, Jean recommends making Tessellate its own library.

Jeff, in terms of GitHub, would we need to rename the repository in order to deliver Tessellate as its own library folder or could it stay as a subset of the OM-CNMAT github repository as it is now?

Would it be difficult/time consuming to make any necessary changes for this? Thanks.

[j-bresson]

I'm not necessarily "recommending" it, it just sounded more logical to me. Any option is ok. In any case, the point was also to be able to keep this om-cnmat foder as a repository for OM libs, in order to avoid creating a new one for each lib.

[mattschumaker]

Thanks for clarifying. Sorry for any misrepresentation.

[j-bresson]

Single cnmat library makes sense, too. I think if doing things modular makes more sense for developers (separate libs for separate concerns / save space and resources / install and use just what you need), users might like better having to install one single library and be sure they have everything in-built. So I guess it's just a choice to make.

[equilet]

@mattschumaker - this is all difficult to decide upon until you have some users. Right now it's mainly you and Edmund using these materials, so I don't know that it's fair for me to comment on it. I generally use separate repositories for separate libraries (as do most GIThub users in my estimation), and we've already been paying extra to the GIThub gods for the extra repositories, so there's no trouble there. W/R/T naming schema, I'd recommend CNMAT-OM-Tesselate etc. If you don't have time for that, just bundle it all together into CNMAT-OM.

[EdmundCampion]

We will keep it just the way it is. With CNMAT-OM/Tessellate library. Then Tessellate itself can be developed, and if anyone else at CNMAT works on further CNMAT-OM, then it will go in another CNMAT-OM/blahblah.

[mattschumaker]

Ok, I made a couple of changes in the folder structure of CNMAT-OM to differentiate the tessellate library from future cnmat-om libraries. If anyone sees further changes needed to help this, please let me know. Changes were:

1) Tessellate source code was put into a separate, “tessellate” folder in the “src” folder and CNMAT-OM.lisp was updated to know where to find tessellate source code for loading.

2) Tessellate overview and help files put into a separate “tessellate” folder in the “examples” folder.

[EdmundCampion]

Still seeing the CNMAT-OM-master folder name when I download. Is there something that can done?

[equilet]

You will see this folder name when you use the 'Clone or download' link rather than downloading an actual release. You'll have to wait until Matt finishes work for the release and then creates one.