Rename packages/6502 directory to packages/core + document the published package#154
Merged
Conversation
Follow-up to renaming the package @learn6502/6502 -> @learn6502/core: the on-disk workspace directory is now packages/core to match the package name. - git mv packages/6502 -> packages/core (the package.json repository.directory now points at packages/core) - fix the only build-critical path reference: translations/build.js xgettext glob ../6502/src -> ../core/src - rename .cursor/rules/package-6502.mdc -> package-core.mdc and its globs - update doc references (AGENTS.md, README.md) and the GitHub directory URLs in tutorial/web content + i18n JSON, .po/.pot and Android strings.xml (the tree/main/packages/6502 links would 404 after the rename); URLs are changed in both msgid and msgstr so gettext keys stay consistent - external links (6502.org, obelisk.me.uk/6502), the app id eu.jumplink.Learn6502 and the @learn6502 scope are deliberately left untouched Workspace symlinks are rewired by a fresh gjsify install; gjsify-lock.json and gjsify-sources.json are unaffected (workspace members aren't external deps).
The package is now published to npm, so document it as a standalone library rather than an internal-only dependency: what it does, install (npm/yarn/pnpm), a verified quick-start (Memory/Labels/Assembler/Simulator wiring), the core classes, the typed event model, disassembly, the memory map, utilities and provenance. All API names, signatures and event names were verified against the package source.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Follow-up to PR #153 (which renamed the npm package
@learn6502/6502→@learn6502/core): this renames the on-disk workspace directorypackages/6502→packages/coreso the folder matches the package name, and rewrites the package's README now that it is published to npm.Directory rename
git mv packages/6502 → packages/core(therepository.directoryfield now points atpackages/core).packages/translations/build.jsxgettext glob../6502/src→../core/src. (No meson/gradle/tsconfig/CI/Flatpak path references exist — the workspace resolves members via thepackages/*glob and by package name.).cursor/rules/package-6502.mdc→package-core.mdcand updated itsglobs:.AGENTS.md, rootREADME.md) and the GitHub directory URLs (tree/main/packages/6502→…/packages/core) in tutorial/web content, i18n JSON,.po/.potand Androidstrings.xml— those links would 404 after the rename. URLs are changed in bothmsgidandmsgstrso gettext keys stay consistent (no orphaned translations); translation files are otherwise untouched (no regeneration churn).6502.org,obelisk.me.uk/6502), the app ideu.jumplink.Learn6502, the@learn6502scope, and CPU/opcode prose. A blanket6502/→core/replace would have corrupted these — only the unambiguouspackages/6502string and the single../6502/relative glob were changed.README
Rewrote
packages/core/README.mdto document@learn6502/coreas a standalone, dependency-free, cross-runtime (Node/GJS/browser) library: what it does, install (npm/yarn/pnpm), a quick-start, the four core classes, the typed event model, disassembly, the memory map, utilities and provenance. All API names, signatures and event names were verified against the package source.Verification (local)
gjsify run check(full workspace type-check) — ✅ exit 0gjsify workspace @learn6502/core build— ✅../core/srcglob + po2json) — ✅ exit 0packages/6502or../6502/path references; external6502links/prose intact.Discovery was done with an 8-agent sweep (build/CI/source/content/pipeline/bare-token) + adversarial false-positive audit to make sure no directory reference was missed and no
6502false positive was changed.