Browse Source

docs: Add better documentation on third-party licenses

Stefan Profanter 4 years ago
parent
commit
bcc08ede05
3 changed files with 50 additions and 0 deletions
  1. 6 0
      README.md
  2. 24 0
      deps/README.md
  3. 20 0
      deps/jsmn/LICENSE

+ 6 - 0
README.md

@@ -70,6 +70,12 @@ On most systems, open62541 requires the C standard library only. For dependencie
 - Default Plugins: The default plugins use the POSIX interfaces for networking and accessing the system clock. Ports to different (embedded) architectures are achieved by customizing the plugins.
 - Building and Code Generation: The build environment is generated via CMake. Some code is auto-generated from XML definitions that are part of the OPC UA standard. The code generation scripts run with both Python 2 and 3.
 
+**Note:**
+Specific optional features are dependent on third-party libraries. These are all listed under the `deps/` folder.
+Depending on the selected feature set, some of these libraries will be included in the resulting library.
+
+More information on the third-party libraries can be found in the corresponding [deps/README.md](deps/README.md)
+
 ### Code Quality
 
 We emphasize code quality. The following quality metrics are continuously checked and are ensured to hold before an official release is made:

+ 24 - 0
deps/README.md

@@ -0,0 +1,24 @@
+# open62541 Third-Party libraries
+
+Specific optional features are dependent on third-party libraries. 
+Any third-party library which may be used is inside this `/deps` folder.
+
+Up to now all these libraries have a less strict License compared to MPL 2.0.
+Anyways you should make sure that the corresponding third-party license matches your needs.
+
+Here's a list of third party libraries:
+
+| Library         | License          | Description                                   |
+|-----------------|------------------|-----------------------------------------------|
+| jsmn            | MIT              | json parser                                   |
+| mdnsd           | BSD-3-Clause     | mDNS library                                  |
+| musl            | MIT              | libc extensions                               |
+| ua-nodeset      | MIT              | Official OPC UA Nodeset files by the OPCF     |
+| atoi            | MIT              | Char to int conversion, from musl             |
+| base64          | BSD              | Base64 encoding and decoding                  |
+| itoa            | MIT              | Int to char conversion                        |
+| ms_stdint       | BSD-3-Clause     | Replacement for stdint on older Visual Studio |
+| open62541_queue | BSD-3-Clause     | FIFO and LIFO queue implementation            |
+| pcg_basic       | Apache License 2 | Random Number Generation                      |
+| string_escape   | MIT              | utf8 encoding and decoding                    |
+| ziptree         | MPL 2.0          | Reusable zip tree implementation              |

+ 20 - 0
deps/jsmn/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Serge A. Zaitsev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+