Skip to content

Add repo scaffolding: .gitignore, README, LICENSE, CHANGELOG, current/.gitkeep#1

Draft
Copilot wants to merge 2 commits into
mainfrom
copilot/setup-gitignore-and-readme
Draft

Add repo scaffolding: .gitignore, README, LICENSE, CHANGELOG, current/.gitkeep#1
Copilot wants to merge 2 commits into
mainfrom
copilot/setup-gitignore-and-readme

Conversation

Copy link
Copy Markdown

Copilot AI commented Mar 15, 2026

PyroFlash had no repo structure beyond a stub README. This sets up the scaffolding needed for a beta-stage manufacturing tool used by technicians and developers.

Changes

  • .gitignore — excludes *.uf2 firmware files and common build/temp artifacts (*.pyc, __pycache__/, *.log, etc.)
  • README.md — full rewrite: beta warning, requirements table (OS, dialout group, PyroProtocolMaster.py path), firmware naming convention ({device}_{version}.uf2), device type table (FM16=3, Relay=6, Aerosol=7), quick start, features list, repo structure diagram
  • LICENSE — MIT
  • CHANGELOG.md — v0.8.0-beta entry covering initial feature set and external dependency notes
  • current/.gitkeep — tracks the firmware drop directory in git without committing any .uf2 files

Constraints respected

  • PyroProtocolMaster.py is documented as external (./fm16test/tools/) — not included
  • Device types remain hardcoded in pyroflash.sh — not moved
  • No firmware files committed
Original prompt

You are helping me set up a GitHub repository for PyroFlash, a manufacturing CLI tool for flashing and configuring pyrotechnic devices.

Project context

  • Repo: burk80/Pyroflash (public)
  • Main script: pyroflash.sh (already exists)
  • Status: Beta v0.8
  • Language: Bash
  • Purpose: Interactive menu-driven device programming via PyroProtocolMaster.py

Current structure

  • pyroflash.sh (main script, 600+ lines)
  • Firmware files: placed in ./current/ directory but NOT committed to git
  • PyroProtocolMaster.py: external tool at ./fm16test/tools/

What I need you to set up

  1. Create/update .gitignore to exclude:

    • *.uf2 (firmware files)
    • Any build/temp artifacts
  2. Create README.md with:

    • Brief description
    • Requirements (Linux, dialout group, PyroProtocolMaster.py location)
    • Firmware naming convention (format: {device}_{version}.uf2)
    • Device type table (FM16=3, Relay=6, Aerosol=7, etc.)
    • Quick start (chmod +x, ./pyroflash.sh)
    • Features list
    • Beta note
  3. Create/organize these if needed:

    • LICENSE (MIT)
    • CHANGELOG.md (start with v0.8 beta)
    • current/.gitkeep (keep the firmware folder in git, empty)
  4. Suggest a good repo structure (docs/, tests/, etc.) if warranted for future growth

Important constraints

  • Keep it simple for now (beta stage)
  • No firmware files committed
  • PyroProtocolMaster.py is external (don't include)
  • Device types are hardcoded in the script (don't move them yet)

Tone

  • Clear, direct, no fluff
  • Assume users are manufacturing technicians + developers
  • Include warning: "Beta - test thoroughly before production use"

Help me structure this professionally but lightly.


📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.

…t/.gitkeep

Co-authored-by: burk80 <36552275+burk80@users.noreply.github.com>
Copilot AI changed the title [WIP] Add .gitignore and README.md for PyroFlash Add repo scaffolding: .gitignore, README, LICENSE, CHANGELOG, current/.gitkeep Mar 15, 2026
Copilot AI requested a review from burk80 March 15, 2026 02:08
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.

2 participants