Skip to content

Rewrite README as an educational landing page#18

Merged
jonfroehlich merged 1 commit into
masterfrom
readme-overhaul
Jun 26, 2026
Merged

Rewrite README as an educational landing page#18
jonfroehlich merged 1 commit into
masterfrom
readme-overhaul

Conversation

@jonfroehlich

Copy link
Copy Markdown
Member

Replaces the 3-line stub README.md with a proper landing page following open-source + education best practices.

Highlights

  • Textbook-first: prominent top-of-page callouts routing newcomers to the physcomp textbook (live + source) and the MakeabilityLab Arduino library before they touch code.
  • Getting started walkthrough (IDE → library → open sketch → select board → upload), pointing at the IDE-setup lesson.
  • Folder map grouped by topic / board / helpers, each linking into the repo.
  • Contributor conventions section pointing at docs/ (header template, legacy list, naming).
  • MIT license + Makeability Lab credit/about.

All external links (lesson page, library repo, homepage) verified to resolve.

Docs-only; no sketches touched.

Replace the 3-line stub with a proper README following open-source/education
best practices: textbook-first framing (prominent callouts to the physcomp
textbook and the MakeabilityLab Arduino library up top), a getting-started
walkthrough, a folder map grouped by topic / board / helpers, and contributor
conventions pointing at docs/. Verified the lesson and library links resolve.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@jonfroehlich jonfroehlich merged commit d558f47 into master Jun 26, 2026
2 checks passed
@jonfroehlich jonfroehlich deleted the readme-overhaul branch June 26, 2026 17:32
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