Authorship

Overview

Every patch or textual source code file should contain a comment listing the names of the authors and the year(s) it was written.

Software developed by CNMAT students, faculty, and staff almost always belongs to the University.

We generally use the standard UC Regents license, which grants "Permission to use, copy, modify, and distribute this software and its documentation for educational, research, and not-for-profit purposes" along with a lot of legal language protecting the University.

There is an even more open license that grants "Permission to use, copy, modify, distribute, and distribute modified versions of this software and its documentation without fee and without a signed licensing agreement", even for for-profit purposes. This is our "open source" license, used, for example, by our OSC libraries, which are included in commercial products by, e.g., Native Instruments.

In the event that we don't have permission to assert a UC copyright, such as with Public Domain Software, the disclaimer should still be included.

Protocol for including authorship

There are two required patches for including your information in a help patch and consequentially, getting it to show up in the overview file.

– banner.maxpat: This is a license and disclaimer patch, which can be found here

– badge2.maxpat: This is a title and description patch, which can be found here.

Here are some steps to follow:

1. Open up badge2.maxhelp
2. Copy an instance from the help patch into your own.
3. Follow the instructions to add your information to this instance.
4. Include the specified arguments for the name, version number, and author.
5. Open up banner.maxhelp
6. Copy an instance from the help patch by following the instructions.
7. Include the specified arguments for the name, description, and color via your bpatcher instance's inspector.