Public release README.md fix

This commit is contained in:
Dmitry Sergeev
2026-09-05 18:50:45 +03:00
parent e13a817245
commit 7f567e43a5
8 changed files with 379 additions and 8 deletions
+30 -8
View File
@@ -13,8 +13,9 @@ video and ImGui rendering; and
> This project is under active development. Builds and feed playback have been
> verified in current Ubuntu and Fedora environments and on a separate Ubuntu
> machine. Native builds and feed playback have also been verified on macOS
> with MoltenVK. macOS packaging, stable releases, and MXL Fabrics support are
> planned.
> with MoltenVK. A macOS application bundle has been tested in a clean virtual
> machine; publication of release artifacts, stable releases, and MXL Fabrics
> support are planned.
## Features
@@ -163,9 +164,29 @@ path, for example:
install_name_tool -add_rpath /absolute/path/to/mxl/lib build/mxl-player
```
These workarounds should not be necessary once the libraries are installed in
a normal dynamic-loader path. A self-contained `.app` bundle and downloadable
GitHub release are planned but do not exist yet.
These workarounds are only needed for development builds. The packaged `.app`
uses bundled libraries and relative runtime paths instead.
### Running the macOS application bundle
The ARM64 `.app` bundle has been tested on physical Apple Silicon hardware. The
application extracted from its release ZIP has also been launched successfully
in a clean macOS installation under UTM, without the development environment or
Homebrew dependencies.
The initial package is unsigned and is not notarized by Apple. Consequently,
Gatekeeper may block its first launch. Right-click **MXL Player.app**, select
**Open**, and confirm the prompt. It can also be allowed from **System Settings
→ Privacy & Security** after a blocked launch.
If macOS still retains a quarantine restriction, it can be removed manually:
```sh
xattr -dr com.apple.quarantine "/Applications/MXL Player.app"
```
Only use this command for an archive downloaded from the project's official
GitHub release and verified against its published SHA-256 checksum.
## Running
@@ -480,11 +501,12 @@ local MXL flow; it will not be implemented as a separate playback backend. See
- Linux builds and feed playback have been verified on Ubuntu and Fedora;
broader runtime and hardware coverage is still limited.
- macOS/MoltenVK builds and feed playback work on tested hardware, but the
application is not yet packaged or release-tested on a clean machine.
- macOS/MoltenVK builds and feed playback work on tested Apple Silicon
hardware. The packaged application launches in a clean UTM macOS VM, but it
remains unsigned and unnotarized.
- Windows support is not currently claimed.
- GPU selection and verbose logging flags are incomplete.
- There are no prebuilt packages or application bundles yet.
- Release artifacts have not yet been published.
- MXL Fabrics ingress is planned but not implemented.
- Native MXL headers and runtime libraries must be ABI-compatible.