Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/workflows/lint-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,8 @@ jobs:
- name: Lint Markdown
uses: DavidAnson/markdownlint-cli2-action@6bf21b07787794f89a243495939cd651942aeabe # v24.1.0
with:
# Changelogs are generated by git-cliff; LICENSE.md preserves canonical licence text.
# Changelogs are generated by git-cliff.
globs: |
**/*.md
#CHANGELOG.md
#CHANGELOG_RELEASE.md
#LICENSE.md
674 changes: 674 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

21 changes: 0 additions & 21 deletions LICENSE.md

This file was deleted.

10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 🎮 chdtool

[![License](https://img.shields.io/github/license/lloydsmart/chdtool)](https://github.com/lloydsmart/chdtool/blob/main/LICENSE.md)
[![License](https://img.shields.io/github/license/lloydsmart/chdtool)](LICENSE)
[![Release](https://img.shields.io/github/v/release/lloydsmart/chdtool)](https://github.com/lloydsmart/chdtool/releases)
[![ShellCheck](https://img.shields.io/github/actions/workflow/status/lloydsmart/chdtool/shellcheck.yml?branch=main&label=shellcheck)](https://github.com/lloydsmart/chdtool/actions/workflows/shellcheck.yml)

Expand Down Expand Up @@ -251,7 +251,7 @@ result at the available CPU count with a minimum of one.
## 📦 Release assets

Each release publishes `.tar.gz` and `.zip` archives containing `chdtool`,
`README.md`, `LICENSE.md`, and `CHANGELOG.md`, plus a standalone `chdtool`
`README.md`, `LICENSE`, and `CHANGELOG.md`, plus a standalone `chdtool`
script. Verify downloads with the published checksum file:

```bash
Expand Down Expand Up @@ -279,3 +279,9 @@ than creating tags or assets manually.
- Better metadata integration
- Optional compression tuning
- Integration with tools like Retromount / ROM managers

---

## License

This project is licensed under the [GNU General Public License v3.0 only](LICENSE).
4 changes: 2 additions & 2 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ When `actionlint` and `markdownlint-cli2` are available, also run:
```bash
actionlint
npx --yes markdownlint-cli2 "**/*.md" "#CHANGELOG.md" \
"#CHANGELOG_RELEASE.md" "#LICENSE.md"
"#CHANGELOG_RELEASE.md" "#LICENSE"
```

Build and validate the release assets locally:
Expand All @@ -71,7 +71,7 @@ with these files:

- `chdtool`
- `README.md`
- `LICENSE.md`
- `LICENSE`
- `CHANGELOG.md`

The `dist/` directory is rebuilt from scratch by the packaging command.
Expand Down
4 changes: 2 additions & 2 deletions scripts/package-release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ stage_dir="$stage_root/$archive_base"
mkdir -p "$stage_dir"

install -m 0755 chdtool.sh "$stage_dir/chdtool"
install -m 0644 README.md LICENSE.md CHANGELOG.md "$stage_dir/"
install -m 0644 README.md LICENSE CHANGELOG.md "$stage_dir/"

# Use the tagged commit timestamp when available, with a stable fallback for
# source archives or local packaging outside a Git checkout.
Expand All @@ -56,7 +56,7 @@ install -m 0755 chdtool.sh "$dist_dir/chdtool"

expected="$(printf '%s\n' \
"$archive_base/CHANGELOG.md" \
"$archive_base/LICENSE.md" \
"$archive_base/LICENSE" \
"$archive_base/README.md" \
"$archive_base/chdtool")"
tar_contents="$(tar -tzf "$dist_dir/$archive_base.tar.gz" | sed '/\/$/d' | LC_ALL=C sort)"
Expand Down