From b08588f823780854a87007054eb01f7ef5f2c578 Mon Sep 17 00:00:00 2001 From: Alex Evans <715855+mmalex@users.noreply.github.com> Date: Sat, 1 Jul 2023 12:38:49 +0100 Subject: move license stuff into a file --- README.md | 31 +++++++------------------------ 1 file changed, 7 insertions(+), 24 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 91d7b65..f966fe8 100755 --- a/README.md +++ b/README.md @@ -7,33 +7,16 @@ I apologise, its been so long since I looked at this, I am releasing a snapshot If you are interested in plinky, please feel free to join our discord community. More information at https://plinkysynth.com -LICENSE -== -Logos & Design ---- -The plinky logo and the design of the front panel design and all other graphic elements (both in code and in the documentation and hardware design) are CC BY-SA 4.0. Full text available at https://creativecommons.org/licenses/by-sa/4.0/ - -Third party elements --- -This repository is still somewhat disorganised, and includes some third party code. This includes (but may not be limited to), code generated by the [STM32 Cube IDE](https://www.st.com/en/development-tools/stm32cubeide.html) default project generator; [tinyusb](https://github.com/hathach/tinyusb); [dear imgui](https://github.com/ocornut/imgui) (which in turn uses [gl3w](https://github.com/skaslev/gl3w) and [glfw](https://github.com/glfw/glfw)), [portaudio](https://github.com/PortAudio/portaudio). These projects remain under their original licenses. - -Software --- -The rest of the software of plinky is licensed under the MIT License https://opensource.org/licenses/MIT - -Hardware +License stuff -- -The hardware design is licensed under the permissive CERN open hardware license, CERN-OHL-P v2. Full text is available at https://cern.ch/cern-ohl. +Please refer to the [license](LICENSE.md) for information including stuff about derived works. -Derived works & Commercial Products +Contributing -- -If you make something with this, I'd love to know! Let me know on [twitter](https://twitter.com/mmalex) - -If you sell or distribute something based on this repo, please make it clear that it is distinct from the original plinky design, and abide by the licenses above. -My main concern is that the small plinky community, who are focused on discussion of creative audio hardware in general, become burdened with support or other work for a product they didn't actively get involved with. We don't want that! So please be respectful. +We need to figure out a process for accepting contributions. Beyond the basics of the license, we may need to investigate using a contributor agreement before accepting pull requests. Advice welcome. Building and stuff -== +-- you need [STM32 cube ide](https://www.st.com/en/development-tools/stm32cubeide.html), its basically the default project so most of the code is in `sw/Core/Src`, most of the rest of the `sw/` folder is just the usual auto generated boilerplate mess. It would be a useful project to update the firmware to build with a more minimal setup; the only significant middleware used relates to USB; while I lean on the STM default project a little, I imagine that the peripheral code could be modified fairly easily. @@ -48,11 +31,11 @@ if there is something missing or something in there that you think shouldn't be Will there still be kit plinkys? eg from Thonk? -== +-- I havent spoken to steve about it, but I don't see why not! Thanks! -== +-- Many thanks to the plinky community, who have helped plinky evolve and kept the dream alive over a few years. Thanks to Steve from https://thonk.co.uk who encouraged plinky into existence and helped produce the kits; to Kay from https://leipzigwest.org/ for tireless hardware help, encouragment and pre-made plinkys! To Stijn from http://www2.thisisnotrocketscience.nl/ for support, hardware help, and the impetus to opensource this. -- cgit v1.2.3