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
19 changes: 19 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## User-facing outcome

<!-- What meaningful behavior, UI or reliability issue does this change solve? -->

## Changes and compatibility

<!-- Files and main architectural decisions; parameter/state/latency compatibility where relevant. -->

## Tests / reproducibility

- [ ] Relevant automated tests were run; logs/commit identified
- [ ] Audio changes: realtime callback safety, numerical and host-state tests
- [ ] GUI changes: actual rendered screenshots at Full, Minimum, MINI and Sidechain
- [ ] Installer or website changes: tested installation/deployment paths and release asset links
- [ ] Physical audio/device claims marked PASS/FAIL/NOT TESTED, with evidence

## Risks and release readiness

<!-- Remaining unverified work and rollback procedure. Do not claim Stable based only on CI. -->
21 changes: 21 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,27 @@ jobs:
- uses: actions/checkout@v4
- name: Validate static site links and screenshots
run: python3 site/scripts/validate_site.py
- name: Verify official public release assets still exist
env:
GH_TOKEN: ${{ github.token }}
shell: bash
run: |
set -euo pipefail
release="repos/$GITHUB_REPOSITORY/releases/tags/v0.2.0-rc.1"
gh api "$release" --jq '.assets[].name' | sort > /tmp/arson-release-assets.txt
for name in \
ArSonComp-0.2.0-Windows-x64-Setup.exe \
ArSonComp-0.2.0-macOS-Universal-AdHoc.pkg \
ArSonComp-0.2.0-macOS-VST3-Universal.zip \
ArSonComp-0.2.0-Ubuntu-Debian-amd64.deb \
ArSonComp-0.2.0-Linux-x86_64-Portable.tar.gz \
SHA256SUMS.txt; do
grep -Fxq "$name" /tmp/arson-release-assets.txt || {
echo "::error::Official release asset missing: $name"; exit 1;
}
done
echo "All linked release files exist on the public tag"

- name: Check native JavaScript syntax
run: node --check site/app.js
- name: Smoke-test static HTTP response
Expand Down
32 changes: 32 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Changelog

This file summarizes meaningful **user-facing** milestones. It does not imply that the current public release is production-stable.

## [Unreleased] — documentation and web readiness

- Publish a responsive, accessible installer download website for Windows, Linux and macOS on GitHub Pages, with Cloudflare Pages-ready static output.
- Use five verified screenshots from the actual Windows JUCE editor.
- Add a professional product README, contribution templates and clear Release Candidate notices.
- Improve onboarding, privacy/support transparency, security reporting and website integrity checks. These updates do **not** rebuild or change the published v0.2.0-rc.1 audio binaries.

## [0.2.0-rc.1] — 2026-11-01

First public installable **Release Candidate**; [release assets and SHA-256 manifest](https://github.com/masarray/arson-comp/releases/tag/v0.2.0-rc.1).

- Windows x64 VST3 + Standalone via Inno Setup.
- Linux x86_64 DEB installer plus per-user portable archive.
- macOS universal VST3/Standalone PKG with ad-hoc bundle signing (installer **not notarized**).
- Original C++17/JUCE audio compressor with Clean, Feedback and Smooth modes; 46 factory preset starting points.
- Compact full/MINI/Sidechain UI with readable live transfer graph, meters, actual silver brushed-metal slider imagery and matte graphite chassis.
- Automated three-platform build and smoke tests. **Physical audio-interface compatibility, xrun stability, pluginval, installer signing and licensing checks remain unverified release gates.**

## Historical engineering milestones (before first public release)

- **M1–M4:** Compressor DSP, parameter/host integration, realtime safety, standalone ASIO path and audio workflow.
- **M5–M6:** Factory preset calibration and compact GUI refinements.
- **M6.1–M6.3:** Knob clearance and user-approved independent PNG track/thumb slider control.
- **M7:** GUI material polish, smaller silver fader caps, and Windows physical-test kit.

The authoritative long-form history is in [engineering validation](docs/VALIDATION.md) and [release status](docs/RELEASE-STATUS.md).

[0.2.0-rc.1]: https://github.com/masarray/arson-comp/releases/tag/v0.2.0-rc.1
11 changes: 11 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Community conduct

ArSonComp welcomes practical, technically grounded contributions from audio developers, DSP engineers, sound professionals and users.

- Be respectful. Do not harass, discriminate, intimidate or personally attack others.
- Critique ideas, code and evidence rather than people. Prefer reproducible examples and measurements over accusations.
- Respect contributor privacy and intellectual property. Do not publish private credentials, recordings or proprietary third-party code without permission.
- Keep pull requests and issues on topic, and disclose relevant conflicts or affiliations when appropriate.
- Maintainers may remove abusive content or restrict participation to protect the community.

For interpersonal concerns, contact a project maintainer privately through an available platform channel; avoid posting private or sensitive complaints publicly. For exploitable software issues, follow [SECURITY.md](SECURITY.md).
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Start physical audio testing at **48 kHz / 128 samples** and move to 64/32 only

**v0.2.0-rc.1 is a public Release Candidate — not a certified production-stable audio release.** The [cross-platform CI run](https://github.com/masarray/arson-comp/actions/runs/41273600039) passed Windows, Linux and macOS builds/tests/packaging. CI does not prove glitch-free audio on physical interfaces or all DAWs, independent pluginval certification, commercially matched sound quality, or notarized macOS installation.

[Current release status](docs/RELEASE-STATUS.md) · [Validation record](docs/VALIDATION.md) · [Architecture](docs/ARD.md) · [Report a problem](https://github.com/masarray/arson-comp/issues/new/choose) · [Contributing](CONTRIBUTING.md)
[Current release status](docs/RELEASE-STATUS.md) · [Changelog](CHANGELOG.md) · [Security policy](SECURITY.md) · [Release readiness checklist](docs/RELEASE-CHECKLIST.md) · [Validation record](docs/VALIDATION.md) · [Architecture](docs/ARD.md) · [Report a problem](https://github.com/masarray/arson-comp/issues/new/choose) · [Contributing](CONTRIBUTING.md)

## Build and licensing

Expand Down
24 changes: 24 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Security policy

## Supported builds

ArSonComp is an early public Release Candidate, not a production-certified audio tool.

| Release line | Status |
| --- | --- |
| v0.2.0-rc.1 | Current publicly available release candidate; security fixes are best effort |
| Older development builds | No guaranteed maintenance |

## Reporting a security vulnerability

**Please do not disclose an exploitable issue in a public GitHub issue or discussion.**

If GitHub private vulnerability reporting is enabled for this repository, use [Report a vulnerability](https://github.com/masarray/arson-comp/security/advisories/new) on the Security tab. If it is not available, request a secure reporting route from the maintainer through a trusted private communication channel; do not send exploit details to a public issue. No security contact email has been published or assumed here.

Include the affected version/commit, operating system, reproducible impact, minimal proof-of-concept details, and a proposed mitigation where possible. Avoid including real user data, passwords or API tokens. Response timelines and bounties are **not guaranteed**.

## Scope and release limitations

Security reports may involve VST3/Standalone loading, malformed preset/state parsing, installer/update paths, privileges, dependencies or website distribution. The site is static and links to official release binaries. Distribution integrity can be verified with the [release SHA-256 checksums](https://github.com/masarray/arson-comp/releases/tag/v0.2.0-rc.1).

Avoid claiming a program is security-certified or physically glitch-free based solely on passing CI. Refer to [release status](docs/RELEASE-STATUS.md) for remaining validation work.
4 changes: 3 additions & 1 deletion docs/LANDING-PAGE-DEPLOYMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,13 @@ It uses **real original M7 JUCE screenshots**, copied by their Git blob SHA from
## Cloudflare Pages — preferred primary site
1. Cloudflare dashboard → Workers & Pages → Create → **Pages** → Connect to Git.
2. Select GitHub masarray/arson-comp and set **production branch = main**.
3. Framework preset = **None**; Build command = **exit 0**; Build output directory = **site**; Root directory = repository root.
3. Framework preset = **None**; Build command = **leave blank (no build)**; Build output directory = **site**; Root directory = repository root.
4. Deploy. A *.pages.dev preview/production URL is created; connect your own domain under Pages → Custom domains when the domain is chosen.
5. Cloudflare automatically previews PR branches and redeploys main after merges.
6. site/_headers ships security/cache headers for Cloudflare Pages. GitHub Pages ignores _headers; both hosts still use the same static assets.

Search indexing and social cards currently use the public GitHub Pages URL as the canonical origin. **When a verified Cloudflare custom domain becomes the primary public URL**, update the canonical and OpenGraph URLs in `site/index.html`, `site/privacy.html`, `site/sitemap.xml`, and `site/robots.txt` together, then verify both hosts. Do not guess a domain or configure redirects before the owner selects it.

Do not add a guessed CNAME or domain. Cloudflare Pages project/domain connection requires the user's Cloudflare account authorization and DNS control. The Git repository is ready, but it is not evidence that a Cloudflare deployment has been performed.

## Content maintenance
Expand Down
34 changes: 34 additions & 0 deletions docs/RELEASE-CHECKLIST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Release qualification checklist — ArSonComp

The public version **v0.2.0-rc.1 is a Release Candidate**. Do not promote to stable until the following gates are evidenced. The checklist is intentionally short, quantitative and reproducible.

## Build, package and artifact integrity
- [x] Windows x64 VST3 + Standalone builds and CTest
- [x] Linux x86_64 build, smoke, DEB and portable packaging
- [x] macOS universal arm64/x86_64, ad-hoc signing verification, PKG/VST3 ZIP
- [x] Official GitHub Release includes SHA-256 checksums
- [x] Actual JUCE screenshot-based public landing, Github Pages deployment
- [ ] Independently run actual installer/uninstaller on clean machines/VMs for each OS, validate user/all-user permissions, DAW visibility, reinstall/upgrade, data preservation and removal
- [ ] Review JUCE/Steinberg SDK licenses and redistribution rights for public binaries

## Host/audio interoperability
- [ ] Pluginval at agreed strictness and log archived
- [ ] At least two independent DAW hosts on Windows, Linux and macOS as supported, VST3 scan and editor open/close
- [ ] Mono/stereo routing, external sidechain, host automation, bypass, and project state save/reopen
- [ ] Host crash/restart resilience, malformed state/preset inputs, repeated plugin instantiation/removal
- [ ] Audible gain matching, dry/wet blend and matched-level comparisons across models and instruments

## Hardware/realtime
- [ ] Physical interface (Maono PS22 on Windows if available) at 48kHz buffers 128, 64, 32; record exact driver and version
- [ ] A direct / B host no plugin / C host bypass / D plugin active comparison under **identical gain/routing**
- [ ] Host-reported dropouts/xruns and callback timing recorded for 1 and 8 instances (CI benchmark is not a replacement)
- [ ] 60-minute active session with GUI opening/closing, CPU and memory trend, xrun count
- [ ] Explicit PASS/FAIL/NOT TESTED evidence bundle for each OS/host/interface combination

## Public trust
- [x] Readable installation instructions and product screenshots from verifiable CI
- [x] Public issue template, security policy and changelog
- [ ] macOS Developer ID signing and Apple notarization for frictionless Gatekeeper experience
- [ ] Domain ownership / Cloudflare Pages primary-site configuration if replacing GitHub Pages

Only after all **blocking** criteria are reviewed by a maintainer should a new stable tag be created; never silently overwrite v0.2.0-rc.1 release assets. See [Windows physical test](WINDOWS-QUICKSTART.md) and [release status](RELEASE-STATUS.md).
34 changes: 33 additions & 1 deletion site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,16 @@
<meta name="theme-color" content="#0b0d12">
<meta name="color-scheme" content="dark">
<meta name="description" content="ArSonComp is a lightweight realtime compressor for vocals, music and live audio. Download VST3 and Standalone for Windows, macOS and Linux.">
<link rel="canonical" href="https://masarray.github.io/arson-comp/">
<meta property="og:url" content="https://masarray.github.io/arson-comp/">
<meta property="og:site_name" content="ArSonComp">
<meta property="og:type" content="website">
<meta property="og:title" content="ArSonComp — Compression that stays in the flow">
<meta property="og:description" content="A focused, low-latency compressor. Download for Windows, macOS and Linux.">
<meta property="og:image" content="https://masarray.github.io/arson-comp/assets/arsoncomp-full.png">
<meta property="og:image:alt" content="Actual ArSonComp compressor GUI with dynamics graph and precision controls">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:image" content="https://masarray.github.io/arson-comp/assets/arsoncomp-full.png">
<meta name="robots" content="index,follow">
<link rel="icon" type="image/svg+xml" href="./favicon.svg">
<link rel="manifest" href="./manifest.webmanifest">
Expand Down Expand Up @@ -154,6 +158,34 @@ <h2>Up and running,<br><span>without the friction.</span></h2>
</div>
</section>

<section class="section section-faq" id="faq" aria-labelledby="faq-heading">
<div class="shell faq-layout">
<div>
<span class="section-kicker">05 / GOOD TO KNOW</span>
<h2 id="faq-heading">A few things<br><span>before you begin.</span></h2>
<p class="faq-intro">Practical answers about installation, compatibility, and the current release.</p>
</div>
<div class="faq-items">
<details>
<summary>My DAW doesn't show ArSonComp after installing. <span aria-hidden="true">+</span></summary>
<p>Restart your DAW and rescan VST3 plug-ins. On Windows, check whether it is installed for the current user or all users; remove older duplicate copies if the host loads one first. See the <a href="https://github.com/masarray/arson-comp/blob/main/docs/INSTALL-PUBLIC.md">installation guide</a>.</p>
</details>
<details>
<summary>Which Linux installer should I choose? <span aria-hidden="true">+</span></summary>
<p>Use the DEB installer for compatible Ubuntu/Debian x86_64 systems. For other modern glibc-based x86_64 distributions, use the portable archive and its per-user install script. Other CPU architectures are not included in this release.</p>
</details>
<details>
<summary>Why does macOS show a security warning? <span aria-hidden="true">+</span></summary>
<p>The universal application and VST3 are ad-hoc signed, but the installer is not Apple notarized. Download only from the official GitHub Release and follow Apple's application approval flow if you trust the file. Do not disable Gatekeeper globally.</p>
</details>
<details>
<summary>Is this version production-stable? <span aria-hidden="true">+</span></summary>
<p>v0.2.0-rc.1 is a public Release Candidate. Automated Windows, Linux, and macOS builds passed. Real hardware dropout tests, independent DAW certification, licensing review, and macOS notarization remain separate release gates. See the <a href="https://github.com/masarray/arson-comp/blob/main/docs/RELEASE-STATUS.md">release status</a>.</p>
</details>
</div>
</div>
</section>

<section class="closing-section">
<div class="shell closing-inner">
<span class="section-kicker">MADE TO MOVE WITH YOU</span>
Expand All @@ -166,7 +198,7 @@ <h2>Make room for the music.</h2>
<footer class="site-footer">
<div class="shell footer-inner">
<div><a class="brand footer-brand" href="#top"><span class="brand-word">ArSon<span>Comp</span></span></a><p>Precision dynamics for real-world audio.</p></div>
<div class="footer-links"><a href="https://github.com/masarray/arson-comp">GitHub</a><a href="https://github.com/masarray/arson-comp/releases">Releases</a><a href="https://github.com/masarray/arson-comp/issues">Support</a><a href="https://github.com/masarray/arson-comp/blob/main/LICENSE">AGPL-3.0</a></div>
<div class="footer-links"><a href="https://github.com/masarray/arson-comp">GitHub</a><a href="https://github.com/masarray/arson-comp/releases">Releases</a><a href="https://github.com/masarray/arson-comp/issues">Support</a><a href="https://github.com/masarray/arson-comp/blob/main/LICENSE">AGPL-3.0</a><a href="./privacy.html">Privacy</a></div>
<div class="footer-legal">© 2026 ArSon Audio. No sonic parity or physical zero-xrun certification implied.</div>
</div>
</footer>
Expand Down
32 changes: 32 additions & 0 deletions site/privacy.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="color-scheme" content="dark">
<meta name="robots" content="index,follow">
<meta name="description" content="How the ArSonComp static download website handles data and third-party download links.">
<link rel="canonical" href="https://masarray.github.io/arson-comp/privacy.html">
<link rel="icon" type="image/svg+xml" href="./favicon.svg">
<link rel="stylesheet" href="./styles.css">
<title>Privacy | ArSonComp</title>
</head>
<body>
<header class="site-header"><div class="shell header-inner">
<a class="brand" href="./" aria-label="Back to ArSonComp"><span class="brand-word">ArSon<span>Comp</span></span></a>
<a class="header-cta" href="./#downloads">Downloads</a>
</div></header>
<main class="shell" style="min-height:65vh;max-width:760px;padding-top:82px;padding-bottom:112px">
<span class="section-kicker">WEBSITE TRANSPARENCY</span>
<h1 style="font-weight:520;font-size:clamp(32px,5vw,46px);letter-spacing:-1.8px;margin:18px 0 22px">Privacy and downloads.</h1>
<p style="color:#afb1b9;line-height:1.85">The ArSonComp landing page is a static website. Its source does not embed advertising trackers, analytics SDKs, third-party fonts, or tracking cookies, and it does not ask for personal information.</p>
<h2 style="font-size:20px;font-weight:560;margin-top:34px">Hosting and download providers</h2>
<p style="color:#afb1b9;line-height:1.85">The site is served via GitHub Pages and may later be served via Cloudflare Pages. These hosting providers may process network request data according to their policies. Installer buttons open official GitHub Release downloads; GitHub may process those requests. We do not operate these services or control their logs.</p>
<h2 style="font-size:20px;font-weight:560;margin-top:34px">Audio and application data</h2>
<p style="color:#afb1b9;line-height:1.85">This privacy note covers the download website only. It does not claim to have audited every runtime or host integration in the audio plugin. Review the open-source implementation for app behavior.</p>
<h2 style="font-size:20px;font-weight:560;margin-top:34px">Questions</h2>
<p style="color:#afb1b9;line-height:1.85">For non-sensitive website issues, visit the <a class="text-link" href="https://github.com/masarray/arson-comp/issues">project issue tracker</a>. For security vulnerabilities, follow the repository <a class="text-link" href="https://github.com/masarray/arson-comp/blob/main/SECURITY.md">security policy</a> rather than publishing exploit details.</p>
<p style="color:#858994;font-size:12px;margin-top:40px">Last updated: November 2026.</p>
</main>
<footer class="site-footer"><div class="shell footer-inner"><div><a class="brand" href="./"><span class="brand-word">ArSon<span>Comp</span></span></a><p>Precision dynamics for real-world audio.</p></div></div></footer>
</body></html>
Loading
Loading