search

jamoma / JamomaMax

Implementation of Jamoma for Cycling'74 Max:
http://www.jamoma.org
41 stars 9 forks source link

User-facing ReadMe and License files #983

Closed tap closed 8 years ago

tap commented 8 years ago

Currently we have a ReadMe.md for developers. We do not have one in the produced package for users.

Similarly we have a LICENSE for developers. We do not have a file in the produced package, thus making things unclear in our distribution.

I'm not sure how urgent or non-urgent this task is for any/all of us...

theod commented 8 years ago

I would say sooner is the better so I can take care of this issue.

what kind of informations should be into the ReadMe.md ? should we guide beginners to the Extras > Overview patcher ?

theod commented 8 years ago

and about the license is the file should be named License.md ? as a first draft is the following text would be ok ?

Jamoma is licensed under the terms of the "New BSD License" (http://creativecommons.org/licenses/BSD/)

tap commented 8 years ago

For the License, yes on the file name. For the content I suggest following the model of the Jamoma2 license:

https://github.com/jamoma/jamoma2/blob/master/LICENSE.md

Though obviously we are using BSD instead of MIT

tap commented 8 years ago

I'm not sure what should be in the readme. I guess a link to the website. Maybe the change log should be there too? But nobody is maintaining that? So maybe it should be removed? Or ???

theod commented 8 years ago

I've put a link to http://www.jamoma.org/max/ webpage into the ReadMe and adding a licence file replacing MIT by BSD.