Skip to content

Replace setup instructions with a complete MicroPython deployment procedure #5

Description

@PurpleSentinel

Problem

The README instructs users to enter BOOTSEL mode, copy the .py files, then copy the UF2 file. BOOTSEL storage is the UF2 flashing volume, not the MicroPython filesystem used for application modules.

The instructions also omit both JSON files. params.json is mandatory; if it is absent, main.py exits before initializing the display. Following the documented procedure therefore cannot produce a working installation.

Relevant locations

  • README.md, Setup
  • main.py, file_in(PARAMS_FILE) and early exit
  • params.json
  • user.json

Acceptance criteria

  • Document flashing the correct MicroPython UF2 first.
  • Document reconnecting through Thonny, mpremote, or another explicit MicroPython file-transfer tool.
  • List every required file, including params.json and the intended handling of user.json.
  • Explain that the entry point must be saved as main.py on the device.
  • Include a first-boot verification and troubleshooting procedure.
  • Test the instructions from a freshly erased board.

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

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions