From 568240083d0127fb18111d91519e2d3f68af300c Mon Sep 17 00:00:00 2001 From: Lars Melchior Date: Wed, 6 Jan 2021 20:20:04 +0100 Subject: [PATCH] add example to Readme --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index d5f7d41..926669c 100644 --- a/README.md +++ b/README.md @@ -34,3 +34,35 @@ cpm_licenses_create_disclaimer_target( ``` building the target `write licenses` (e.g. calling `cmake --build build --target write-licenses`) will create the file `third_party.txt` in your build directory, containing all license disclaimers of dependencies added by CPM.cmake. + +## Example output + +The generated disclaimer contains the name of the dependency as well as the included license text. Below is an example of the disclaimer generated for [Catch2](https://github.com/catchorg/Catch2). + +``` +The following software may be included in this product: Catch2. This software contains the following license and notice below: + +Boost Software License - Version 1.0 - August 17th, 2003 + +Permission is hereby granted, free of charge, to any person or organization +obtaining a copy of the software and accompanying documentation covered by +this license (the "Software") to use, reproduce, display, distribute, +execute, and transmit the Software, and to prepare derivative works of the +Software, and to permit third-parties to whom the Software is furnished to +do so, all subject to the following: + +The copyright notices in the Software and this entire statement, including +the above license grant, this restriction and the following disclaimer, +must be included in all copies of the Software, in whole or in part, and +all derivative works of the Software, unless such copies or derivative +works are solely in the form of machine-executable object code generated by +a source language processor. + +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, TITLE AND NON-INFRINGEMENT. IN NO EVENT +SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. +```