Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 15, 2025

The bondmachine command lacked user-facing documentation. Added comprehensive README.md covering all functionality.

Documentation Structure

  • Installation and Overview: Quick start and command purpose
  • Core Features (100+ flags organized by category):
    • Machine construction (domains, processors, I/O, bonds, shared objects)
    • Simulation and emulation modes
    • Verilog/HDL generation with board-specific support (Basys3, iCE40 variants)
    • Peripheral integration (VGA, PS2, UART, counters)
    • Clustering protocols (Etherbond, UDPBond, Bondirect)
    • BMAPI generation for Go/C/Python
  • Usage Examples: Common workflows from machine creation to FPGA deployment
  • Reference: File formats, architecture flow, tips, related commands

Follows existing documentation patterns from cmd/simbox and cmd/bmnumbers for consistency.

Original prompt

This section details on the original issue you should resolve

<issue_title>bondmachine command readme</issue_title>
<issue_description>Write a README.md file with the documentation for the bondmachine command. The file should be in cmd/bondmachine/</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: mmirko <7934656+mmirko@users.noreply.github.com>
Copilot AI changed the title [WIP] Add README.md documentation for bondmachine command Add comprehensive README documentation for bondmachine command Dec 15, 2025
Copilot AI requested a review from mmirko December 15, 2025 09:14
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.

bondmachine command readme

2 participants