Skip to content

docs: add repository map to README - #9

Open
sit-d wants to merge 1 commit into
bitRAKE:masterfrom
sit-d:curation/readme-map-2026-06-29
Open

docs: add repository map to README#9
sit-d wants to merge 1 commit into
bitRAKE:masterfrom
sit-d:curation/readme-map-2026-06-29

Conversation

@sit-d

@sit-d sit-d commented Jun 29, 2026

Copy link
Copy Markdown

Summary

  • Expand the root README from a one-line description into a quick repository map.
  • Link the main sample areas (math, win64, win64.coff, Vulkan, string, books, etc.) so readers can navigate the playground faster.
  • Document that there is no repository-wide build and that examples should be built from their nearest local build.cmd, Makefile, readme, or source comments.

Verification

  • python3 local-link check over README.md: checked 18 local README links; all resolved.
  • git diff --check: passed.

Notes / Limitations

  • Documentation-only change; no assembler/toolchain build was run.
  • Existing Windows/fasmg examples were not modified.

@sit-d
sit-d force-pushed the curation/readme-map-2026-06-29 branch from 72258f4 to 5227892 Compare June 29, 2026 21:54
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