From a4eb3b1887126809407b88d7ac344d99144e046c Mon Sep 17 00:00:00 2001 From: BlubbFish <git@blubbfish.net> Date: Wed, 29 May 2019 23:48:05 +0200 Subject: [PATCH] Add CONTRIBUTING.md, LICENSE and README.md Update all submodules --- CONTRIBUTING.md | 92 ++++++++++++++++++++++ LICENSE | 165 ++++++++++++++++++++++++++++++++++++++++ Librarys/Mono.Posix | 2 +- Librarys/RaspberryIO | 2 +- Librarys/litjson | 2 +- Librarys/mqtt | 2 +- Lora | 2 +- Lora-Bot | 2 +- README.md | 5 ++ Utils/Bot-Utils | 2 +- Utils/ConnectorDataMqtt | 2 +- Utils/Iot-Interfaces | 2 +- Utils/Utils | 2 +- Utils/Utils-IoT | 2 +- 14 files changed, 273 insertions(+), 11 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..20ec6e2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,92 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via issue, +email, or any other method with the owners of this repository before making a change. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Pull Request Process + +1. Ensure any install or build dependencies are removed before the end of the layer when doing a + build. +2. Update the README.md with details of changes to the interface, this includes new environment + variables, exposed ports, useful file locations and container parameters. +3. Increase the version numbers in any examples files and the README.md to the new version that this + Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). +4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you + do not have permission to do that, you may request the second reviewer to merge it for you. + +## Code of Conduct + +### Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +### Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +### Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +### Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +### Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at git ATTTT blubbfish.net. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +### Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f0156c5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. \ No newline at end of file diff --git a/Librarys/Mono.Posix b/Librarys/Mono.Posix index 749da0d..6b5d3e0 160000 --- a/Librarys/Mono.Posix +++ b/Librarys/Mono.Posix @@ -1 +1 @@ -Subproject commit 749da0d8db24cd037bdfb93761d31282f361923c +Subproject commit 6b5d3e07cca0e315bd32c4166f036cd61757b922 diff --git a/Librarys/RaspberryIO b/Librarys/RaspberryIO index e7c3f7a..d75c3bc 160000 --- a/Librarys/RaspberryIO +++ b/Librarys/RaspberryIO @@ -1 +1 @@ -Subproject commit e7c3f7af917732400a41db3d2ad9a8aef3f4f8b4 +Subproject commit d75c3bc73fb9ec707ae1328d84d011624746e7e3 diff --git a/Librarys/litjson b/Librarys/litjson index 853958a..021417c 160000 --- a/Librarys/litjson +++ b/Librarys/litjson @@ -1 +1 @@ -Subproject commit 853958acdaabc04625ebc390ca3255d51b049b36 +Subproject commit 021417c029bed6805885706d7e58fdba4ba6c92e diff --git a/Librarys/mqtt b/Librarys/mqtt index 10a7317..57f343c 160000 --- a/Librarys/mqtt +++ b/Librarys/mqtt @@ -1 +1 @@ -Subproject commit 10a7317bc080299291076144b1d3294812bc6ca9 +Subproject commit 57f343c908f4421c75da87652920f82d457ec6a1 diff --git a/Lora b/Lora index 827d369..20c3638 160000 --- a/Lora +++ b/Lora @@ -1 +1 @@ -Subproject commit 827d369ca6c5c4690c6de16f5a40cec6d1375c87 +Subproject commit 20c363897064a3d2349fb95ffa254a4b9abb1e46 diff --git a/Lora-Bot b/Lora-Bot index 7fbd6ef..17cd18a 160000 --- a/Lora-Bot +++ b/Lora-Bot @@ -1 +1 @@ -Subproject commit 7fbd6efd0678ebf875107e195064589ec13af8ac +Subproject commit 17cd18ae81e5b30129e054ed5bf6788962111157 diff --git a/README.md b/README.md new file mode 100644 index 0000000..d0bfa69 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# Lora-Gateway Project +Project that contains the Lora library, the Lora-Bot and all its dependencies. + +## Howto +Please checkout this project with it submodules and run Lora-Bot/Lora-Bot.sln to build a release. Then run Lora-Bot/Lora-Bot/dpkg/create-Builds.bat, it creates a deb file that you can install with `sudo dpkg -i armhf-lorabot_x.x-x.deb` \ No newline at end of file diff --git a/Utils/Bot-Utils b/Utils/Bot-Utils index 39eac52..37e185b 160000 --- a/Utils/Bot-Utils +++ b/Utils/Bot-Utils @@ -1 +1 @@ -Subproject commit 39eac5222c8c79b91fc65d805d00ca094dc69964 +Subproject commit 37e185bceb09e029288719ee3438c39acbf80a68 diff --git a/Utils/ConnectorDataMqtt b/Utils/ConnectorDataMqtt index e8812fa..20f0390 160000 --- a/Utils/ConnectorDataMqtt +++ b/Utils/ConnectorDataMqtt @@ -1 +1 @@ -Subproject commit e8812fa80b6f9be9f8d27f94942181dd88a516de +Subproject commit 20f0390077486e95124c5ac67fe54f8b13263397 diff --git a/Utils/Iot-Interfaces b/Utils/Iot-Interfaces index f5be5cb..e61b710 160000 --- a/Utils/Iot-Interfaces +++ b/Utils/Iot-Interfaces @@ -1 +1 @@ -Subproject commit f5be5cbb7ccbf35e0299a3bb17a4b44965b1103f +Subproject commit e61b7106e29ed0364c62d478626d60394920f424 diff --git a/Utils/Utils b/Utils/Utils index c313994..8606362 160000 --- a/Utils/Utils +++ b/Utils/Utils @@ -1 +1 @@ -Subproject commit c313994aeb408d3a073a59123d4e14e80089ad58 +Subproject commit 8606362ed78dca7f0fd9138e75de549d726d9018 diff --git a/Utils/Utils-IoT b/Utils/Utils-IoT index 4a9afc8..737b987 160000 --- a/Utils/Utils-IoT +++ b/Utils/Utils-IoT @@ -1 +1 @@ -Subproject commit 4a9afc8ec2cbd8ac4a84beb29ec05b0465a4548e +Subproject commit 737b98778a6caa1b7296ff789e729dd6aa95fb25 -- GitLab