mirror of
https://github.com/baketnk/frame-yap.git
synced 2026-10-06 03:00:04 +02:00
Update packaging documentation for published native releases
This commit is contained in:
1 parent
bcd330d42c
commit
2c0e4ca4dc
3 files changed
+16
-12
No files matched your search
@@ -73,7 +73,8 @@ missing-runtime panel message and the battery readouts on Frame.
|
|||||||
- [x] **A3. Commit the pending `AGENTS.md` rename** ("Frame Dictation" →
|
- [x] **A3. Commit the pending `AGENTS.md` rename** ("Frame Dictation" →
|
||||||
"FrameYap"). (S) Done in baseline checkpoint `07c03ea`.
|
"FrameYap"). (S) Done in baseline checkpoint `07c03ea`.
|
||||||
- [~] **A4. Runtime dependency pointers.** Repos and licenses are listed in
|
- [~] **A4. Runtime dependency pointers.** Repos and licenses are listed in
|
||||||
`docs/third-party.md`. No release audit is needed while v0.1 is source-only.
|
`docs/third-party.md`. Audit the staged native libraries and notices for each published archive;
|
||||||
|
speech runtime packages and model files remain separate explicit downloads.
|
||||||
- [x] **A5. Drop "POC" from the shipped surface.** (S) Public help, README,
|
- [x] **A5. Drop "POC" from the shipped surface.** (S) Public help, README,
|
||||||
CMake and installer use the release name. `scripts/stage-native-poc.py` remains
|
CMake and installer use the release name. `scripts/stage-native-poc.py` remains
|
||||||
a deprecated compatibility wrapper for `scripts/stage-native.py`, not the
|
a deprecated compatibility wrapper for `scripts/stage-native.py`, not the
|
||||||
|
|||||||
+11
-9
@@ -1,7 +1,7 @@
|
|||||||
# Release packaging and idempotent user-local installer
|
# Release packaging and idempotent user-local installer
|
||||||
|
|
||||||
**No GitHub release is published.** Native-only local artifacts have been installed
|
Native-only GitHub release archives are published with the standalone installer.
|
||||||
and reinstalled on Frame. The installer never pretends an ASR runtime is included when it is not;
|
The ARM64 artifacts are built, tested, installed and checked on Frame before publication. The installer never pretends an ASR runtime is included when it is not;
|
||||||
see [third-party notes](third-party.md).
|
see [third-party notes](third-party.md).
|
||||||
|
|
||||||
## Producer
|
## Producer
|
||||||
@@ -25,9 +25,9 @@ runtime/bin/python3 # ONLY for an authorized bundled-runtime artif
|
|||||||
The stage copies the self-contained installer into `bin/` and CMake installs
|
The stage copies the self-contained installer into `bin/` and CMake installs
|
||||||
`scripts/model-status.py` alongside the backend manifests. The package allowlist
|
`scripts/model-status.py` alongside the backend manifests. The package allowlist
|
||||||
permits `scripts/`; installed `frameyap --list-models` expects the verifier at
|
permits `scripts/`; installed `frameyap --list-models` expects the verifier at
|
||||||
`../scripts/model-status.py`. **No actual staged archive has been audited/tested
|
`../scripts/model-status.py`. Exercise the entire producer pipeline and installed CLI for each release.
|
||||||
from a clean account for publication**; exercise the entire producer pipeline
|
Upgrade validation on the existing Frame account does not establish a clean-account
|
||||||
and the installed CLI before treating the payload layout as release-ready.
|
installation or general platform compatibility.
|
||||||
|
|
||||||
For the current **external-runtime** package, `scripts/stage-native.py --help`
|
For the current **external-runtime** package, `scripts/stage-native.py --help`
|
||||||
documents explicit inputs. The old `scripts/stage-native-poc.py` is retained as
|
documents explicit inputs. The old `scripts/stage-native-poc.py` is retained as
|
||||||
@@ -76,18 +76,19 @@ bootstrap, **not** the inference runtime), curl for network release downloads,
|
|||||||
sha256sum and tar for archive handling. **No compiler, sudo, Steam store AppID
|
sha256sum and tar for archive handling. **No compiler, sudo, Steam store AppID
|
||||||
or engine checkout in binary mode.** No minimum glibc floor has been certified;
|
or engine checkout in binary mode.** No minimum glibc floor has been certified;
|
||||||
preflight alone cannot guarantee compatibility. Download/inspect a pinned installer
|
preflight alone cannot guarantee compatibility. Download/inspect a pinned installer
|
||||||
before running it. Current local artifact route:
|
before running it. Local artifact route:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
sh install.sh --archive /path/to/frameyap-VERSION-linux-aarch64.tar.gz \
|
sh install.sh --archive /path/to/frameyap-VERSION-linux-aarch64.tar.gz \
|
||||||
--sha256 64_HEX_DIGIT_HASH --version VERSION
|
--sha256 64_HEX_DIGIT_HASH --version VERSION
|
||||||
```
|
```
|
||||||
|
|
||||||
After an actual vetted release exists, use a real numeric version (for example,
|
For a published release, use its numeric version (for example,
|
||||||
`sh install.sh --mode binary --version 0.1.202609241627 --yes`); the installer
|
`sh install.sh --mode binary --version 0.1.202609241627 --yes`); the installer
|
||||||
will retrieve tag `v0.1.202609241627` and its versioned checksum; no `latest` or moving-branch
|
will retrieve tag `v0.1.202609241627` and its versioned checksum; no `latest` or moving-branch
|
||||||
lookup. A pipe invocation is supported, never reads answers from the pipe, and must also
|
lookup. A pipe invocation is supported, never reads answers from the pipe, and must also
|
||||||
pin a real published tag. **There is no functional public download command yet.**
|
pin a real published tag. The README's `releases/latest/download/install.sh` bootstrap
|
||||||
|
selects the fixed release version embedded in that published installer.
|
||||||
|
|
||||||
`--without-model` omits any model files in the selected archive, never deletes
|
`--without-model` omits any model files in the selected archive, never deletes
|
||||||
an existing current model on rerun, and records the choice. Same
|
an existing current model on rerun, and records the choice. Same
|
||||||
@@ -116,7 +117,8 @@ only the new venv and leaves `paths.conf` unchanged. `--print-plan --json` shows
|
|||||||
the packages, index and size (about 200 MB of wheels, roughly 1–1.5 GB on disk)
|
the packages, index and size (about 200 MB of wheels, roughly 1–1.5 GB on disk)
|
||||||
without touching anything. The app must be closed (install lock). Transitive
|
without touching anything. The app must be closed (install lock). Transitive
|
||||||
dependencies are not pinned. Validated end to end on x86-64 Python 3.12
|
dependencies are not pinned. Validated end to end on x86-64 Python 3.12
|
||||||
(2026-09-25); a clean Frame install is still pending.
|
(2026-09-25); the owner also reported a successful fresh Frame model/runtime
|
||||||
|
installation from v0.1.202609251524. Later upgrade tests preserve that runtime.
|
||||||
In the source tree, `python3 scripts/model-status.py --list-models` or
|
In the source tree, `python3 scripts/model-status.py --list-models` or
|
||||||
`--check-model redux --model-dir /absolute/model` hash-checks local files;
|
`--check-model redux --model-dir /absolute/model` hash-checks local files;
|
||||||
the native `frameyap --list-models` / `--check-model` entry points use the
|
the native `frameyap --list-models` / `--check-model` entry points use the
|
||||||
|
|||||||
+3
-2
@@ -2,8 +2,9 @@
|
|||||||
|
|
||||||
FrameYap's own code is under [LICENSE](../LICENSE). Everything below is fetched
|
FrameYap's own code is under [LICENSE](../LICENSE). Everything below is fetched
|
||||||
from, or built against, its upstream project; each keeps its own license. This is
|
from, or built against, its upstream project; each keeps its own license. This is
|
||||||
a pointer list, not a legal audit. No prebuilt archive is published: v0.1 is
|
a pointer list, not a legal audit. Published native archives include SDL3 and the OpenVR client library, plus
|
||||||
source-only, and Python packages are fetched from PyPI on the user's machine.
|
the font and required notices. The speech runtime and model are downloaded
|
||||||
|
separately on the user's machine; they are not redistributed in the archive.
|
||||||
|
|
||||||
## Included in this repository
|
## Included in this repository
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user