slint/scripts/prepare_binary_package.sh
Simon Hausmann a7f965c941 Include list of third-party licenses in the C++ docs
This isn't very pretty, but I think it does the job.

cc #6634
2024-12-16 21:54:37 +01:00

73 lines
2.5 KiB
Bash
Executable file

#!/bin/bash -e
# Copyright © SixtyFPS GmbH <info@slint.dev>
# SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-Slint-Royalty-free-2.0 OR LicenseRef-Slint-Software-3.0
if [ $# -lt 1 ]; then
echo "usage: $0 path/to/target/binary_package"
echo
echo "This prepares the specified binary_package folder for distribution"
echo "by adding the legal copyright and license notices."
echo
echo "All files will be copied/created under the licenses folder"
echo "along with an index.html"
echo
exit 1
fi
target_path=$1/licenses
mkdir -p $target_path
cp -a `dirname $0`/../LICENSE.md $target_path
cat > about.hbs <<EOT
<!DOCTYPE html>
<html>
<head>
<style>
@media (prefers-color-scheme: dark) {
body { background: #333; color: white; }
a { color: skyblue; }
}
.container { font-family: sans-serif; max-width: 800px; margin: 0 auto; }
.intro { text-align: center; }
.licenses-list { list-style-type: none; margin: 0; padding: 0; }
.license-used-by { margin-top: -10px; }
.license-text { max-height: 200px; overflow-y: scroll; white-space: pre-wrap; }
</style>
</head>
<body>
<main class="container">
<div class="intro">
<p>This program is distributed under the terms outlined in <a href="LICENSE.md">LICENSE.md</a></p>.
<h1>Third Party Licenses</h1>
<p>This page lists the licenses of the dependencies used by this program.</p>
</div>
<h2>Overview of licenses:</h2>
<ul class="licenses-overview">
{{#each overview}}
<li><a href="#{{id}}">{{name}}</a> ({{count}})</li>
{{/each}}
</ul>
<h2>All license text:</h2>
<ul class="licenses-list">
{{#each licenses}}
<li class="license">
<h3 id="{{id}}">{{name}}</h3>
<h4>Used by:</h4>
<ul class="license-used-by">
{{#each used_by}}
<li><a
href="{{#if crate.repository}} {{crate.repository}} {{else}} https://crates.io/crates/{{crate.name}} {{/if}}">{{crate.name}}
{{crate.version}}</a></li>
{{/each}}
</ul>
<pre class="license-text">{{text}}</pre>
</li>
{{/each}}
</ul>
<main></body></html>
EOT
cargo about generate -c `dirname $0`/../about.toml about.hbs -o $target_path/index.html