Skip to content

docs: tidy the READMEs for amdl 2.0 - #22

Merged
LYJW131 merged 2 commits into
litefrom
docs/readme-tidy
Nov 3, 2026
Merged

LYJW131 merged 2 commits into
litefrom
docs/readme-tidy

Conversation

@LYJW131

@LYJW131 LYJW131 commented Nov 3, 2026 •

Copy link
Copy Markdown
Member

Rewrites the root README (what it is, three ways to run it, release assets, differences from upstream), brings manager/ and the QEMU READMEs in line with the code (payload pinning, -update-wrapper, release assets, no stale nightly.link/build-manager-qemu text).

Docs only; every command was checked against the code or workflows.

🤖 Generated with Claude Code


Devin Review

The root README now says what the repo is, the shortest way to run it (amdl
desktop app, Docker or Linux host, Cloudflare), the release assets and what
differs from upstream. The manager README drops the nightly.link, build-manager-qemu
and AppleMusicDecrypt text, documents payload pinning and -update-wrapper.
The QEMU READMEs no longer repeat the root's launcher notes.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Signed-off-by: LYJW131 <153256373+LYJW131@users.noreply.github.com>

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 2 potential issues.

Devin Review

Comment thread manager/README.md
Comment on lines +74 to +76
By default the manager installs the newest `build-lite` artifact on `lite`
(`wrapper-lite-linux-x86_64.zip`, `…-aarch64.zip` on arm64) into `data/wrapper/`,
recording where it came from in `data/wrapper/.payload-source`. To run a fixed

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔍 Arm64 payload is not published

The documented arm64 payload has no matching build-lite artifact. The manager constructs its URL, but the workflow only uploads x86_64; arm64 users need the documented QEMU route.

Devin Review


Was this helpful? React with 👍 or 👎 to provide feedback.

Comment thread README.md Outdated
Comment on lines +27 to +37
git clone -b lite https://github.com/AMDL-Web/wrapper
cd wrapper/manager
docker compose up -d # API on localhost:8080; the container is privileged
```

Without Docker (Linux x86_64, user namespaces and chroot available):

```shell
cd wrapper/manager
go build -o wrapper-manager .
./wrapper-manager -host 0.0.0.0 -port 8080

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟥 Quickstart exposes unauthenticated account API

Following either quickstart exposes wrapper-manager beyond localhost. Docker publishes 8080:8080 on every interface, and the native command binds 0.0.0.0. Anyone who reaches the port can read /token and manage accounts.

Devin Review


Was this helpful? React with 👍 or 👎 to provide feedback.

…blished

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Signed-off-by: LYJW131 <153256373+LYJW131@users.noreply.github.com>
@LYJW131
LYJW131 merged commit 4fbac6b into lite Nov 3, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant