Skip to content

Commit

Permalink
add example to Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
TheLartians committed Jan 6, 2021
1 parent 3952b53 commit 5682400
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```

0 comments on commit 5682400

Please sign in to comment.