summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5addcb0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,66 @@
+# AeroCore Accelerator NG Releases
+
+This repository is the official distribution point for **AeroCore Accelerator
+NG**, a fully standalone, next-generation game network optimization client. It
+is designed to improve connection stability and reduce latency, jitter, and
+packet loss on supported routes.
+
+It contains installers and release metadata only. Product source code is
+maintained separately.
+
+## Downloads
+
+Download published builds from the
+[Releases](https://github.com/AeroCore-IO/instruments-releases/releases) page.
+
+A release may contain:
+
+- `instruments-ng_v<VERSION>_linux-x86_64.tar.gz` — application and runtime
+ bundle.
+- `instruments-ng_v<VERSION>_linux-x86_64.tar.gz.sha256` — bundle checksum.
+- `AeroCore-Instruments-Setup_v<VERSION>_linux-x86_64.AppImage` — online
+ installer.
+- `AeroCore-Instruments-Full-Setup_v<VERSION>_linux-x86_64.AppImage` — offline
+ installer, when published.
+- A component manifest recording the versions and source revisions used in
+ the build.
+
+Release candidates use tags such as `v0.1.0-rc.1` and are marked as
+pre-releases. They are intended for testing and may be incomplete or unstable.
+
+## Verifying a Download
+
+When a SHA-256 file is provided, verify the downloaded artifact before running
+it:
+
+```bash
+sha256sum --check instruments-ng_v<VERSION>_linux-x86_64.tar.gz.sha256
+```
+
+Compare the result with the checksum published in the same release.
+
+## Licensing
+
+AeroCore Accelerator NG distributions may contain components under different
+licenses:
+
+- Components derived from GPL-licensed projects remain available under their
+ applicable GPL terms.
+- HHD-derived components and libraries may be covered by LGPL or by
+ file-specific licenses.
+- Separately executed AeroCore runtime services may be proprietary.
+- Other third-party libraries retain their respective licenses and copyright
+ notices.
+
+The license and notice files accompanying each release identify the terms that
+apply to its individual components. No proprietary term restricts rights
+granted for GPL- or LGPL-covered components.
+
+See [LICENSE](LICENSE) for the repository-level distribution notice. When a
+release contains copyleft-covered binaries, its release notes or accompanying
+materials identify how recipients can obtain the corresponding source code.
+
+## Support
+
+Use the support channel identified by AeroCore Accelerator NG or its release
+notes. Do not report security-sensitive information in a public issue.