Skip to content

Document where the code lives: link external repos (arduino, makelab-arduino-lib, signals) from README & textbook #135

Description

@jonfroehlich

Summary

The physcomp README (and arguably the textbook/website itself) doesn't clearly state where the code featured in the lessons actually lives. The code is hosted across several separate GitHub repos, but a reader landing on the textbook has no obvious pointer to them.

Why

Much of the textbook references and embeds code (Arduino sketches, the shared Arduino library, Signals examples, p5.js sketches), but the source-of-truth repos are external to this one. Readers, students, and contributors should be able to find them easily — to browse full examples, file issues, or contribute.

External code repos to surface

Proposed

  • Add a clearly-labeled "Where the code lives" section to the README listing each external repo and what it contains.
  • Consider surfacing the same pointers in the textbook/website itself (e.g. an intro/"about the code" page or footer link), not just the README, so end readers see it too.
  • Note the relationship between the repos (e.g. that the Arduino sketches depend on the MakeabilityLab Arduino library).

Related

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    code-examplesEmbedded source code, sketch/code links, .ino syncdocumentationImprovements or additions to documentationv2.0Targeted for the Version 2.0 release

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions