Skip to content

docs: expand README with tech stack, features, and project structure#4

Open
nightshift-micr wants to merge 1 commit intomicr-dev:mainfrom
nightshift-micr:nightshift/readme-improvements
Open

docs: expand README with tech stack, features, and project structure#4
nightshift-micr wants to merge 1 commit intomicr-dev:mainfrom
nightshift-micr:nightshift/readme-improvements

Conversation

@nightshift-micr
Copy link
Copy Markdown

@nightshift-micr nightshift-micr commented Apr 21, 2026

Summary

Expanded the README to help contributors understand the project:

  • Tech Stack — documented Spline, fflate, Howler.js, opentype.js, and CRT shader
  • Features — listed the key interactive features (3D scene, ASCII animation, spatial audio, CRT effects, WASM typography)
  • Browser Requirements — called out hardware acceleration requirement
  • Project Structure — added a tree view of the codebase
  • Local Development — added simple npx serve . / python3 -m http.server instructions

No functional code changes. README-only diff.

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 21, 2026

👷 Deploy request for micrdev pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit c8b580f

@nightshift-micr nightshift-micr force-pushed the nightshift/readme-improvements branch from dc1d113 to c8b580f Compare April 22, 2026 09:33
@nightshift-micr nightshift-micr changed the title [nightshift] readme-improvements: add tech stack, project links, overview docs: expand README with tech stack, features, and project structure Apr 22, 2026
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