docs: refresh README (prominent textbook links + education best practices)#29
Merged
Conversation
…t practices) - Add a top callout + badge linking the Physical Computing textbook (home + signals module + source repo) so it's front-and-center. - Add status badges: CI, Python 3.12, MIT license, textbook. - New "Who this is for & how to use" section (students vs instructors). - Add Contributing, Citing, and Acknowledgments sections. - Fix stale text: notebooks now ship complete with `### Example solution` cells (issue #6); StepTracker is consolidated, so drop the old "*-WithExampleSolution as answer key" description. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
Refreshes the README following open-source + education best practices. Targeted revision of the existing README (kept the good lesson table, dual setup paths, tests, and layout).
Changes
### Example solutioncells (Consider whether it's worth keeping the student TODOs or show full complete .ipynbs #6) and StepTracker is consolidated, so removed the old "*-WithExampleSolution= answer key" description.No content/notebook changes; docs only.
🤖 Generated with Claude Code