search

zxdavb / ramses_protocol

RAMSES-II is a Honeywell RF protocol for HVAC and CH/DHW
MIT License
45 stars 9 forks source link

Pull request in wiki #3

Open reneklootwijk opened 3 years ago

reneklootwijk commented 3 years ago

First of all complements for your accomplishments so far.

Based on this documentation I am creating a Nodejs module implementing the protocol. Along the way I found some errors and missing parts in the wiki documentation . I cloned the wiki and am making updates to the documentation. While github does not allow pull requests on the wiki repository it would be nice if you can make the wiki available as a folder in your main repository so updates can be easily submitted as pull requests.

zxdavb commented 3 years ago

@reneklootwijk

Please be aware the wiki is not up-to-date. The (IMHO) authorative source on info re: the RAMSES protocol is at: https://github.com/zxdavb/evohome_rf

In particular, see:

reneklootwijk commented 3 years ago

I would very much like to use your code as a reference, however the code is using the GPL3 license and if I would respect that license my Nodejs code should also be released using GPL3 while I would like to use MIT. Would nice if you are willing to change the license or give me an approval to use your code as a reference while releasing my code using MIT.

zxdavb commented 3 years ago

Let's see what I can do - what is it about MIT that GPLv3 doesn't provide for you.

It it only because node.js is MIT and including GPL is incompatible with that?

reneklootwijk commented 3 years ago

I do not like to impose any restrictions on how my code is used, distributed, copied etc. as long as the copyright is mentioned. For that reason I always release my code using a permissive license and my choice is MIT. Using GPL3 released software makes this impossible because I have to inherit the GPL3 license.

reneklootwijk commented 3 years ago

This is a nice overview of the various license models: https://www.bbvaapimarket.com/en/api-world/infographic-what-are-open-source-license/

zxdavb commented 3 years ago

No worries, we'll come up with a plan for you - I only ask for attribution.

reneklootwijk commented 3 years ago

I always mention the references I used explicitly when I release my code.

zxdavb commented 3 years ago

OK, try that

zxdavb commented 3 years ago

@reneklootwijk

it would be nice if you can make the wiki available as a folder in your main repository

Could you let me know how I might best do this?

reneklootwijk commented 3 years ago

There is no best way seems. I never used the wiki of github so have no experience.

Here some people describe how they cope with it: https://sparkbox.com/foundry/github_wiki_tutorial_for_technical_wiki_documentation

It is a bit silly, but you need to create either a separate repository for the wiki (or create a folder in your current repository to hold the files). This can then be used for managed, merging, pull requests etc. After merging the files then have to pushed to the repository of the wiki, where only the owner can commit and push.