Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 15, 2025

The procbuilder README was incomplete with TODO placeholders and minimal flag documentation. This rewrite provides complete reference documentation for all 30+ command-line flags.

Changes

  • Flag documentation: All flags organized into logical categories (architecture config, program input, HDL generation, simulation, inspection)
  • Practical examples: 9 examples covering processor creation, assembly, HDL generation, and simulation workflows
  • Workflow guides: Common development scenarios (new processor development, hardware implementation, program testing)
  • Technical details: JSON machine file format, execution models (Von Neumann/Harvard/Hybrid), opcode optimization

Structure

Installation
├── Architecture Configuration (execution model, registers, memory, I/O)
├── Instruction Set Configuration (opcodes, optimizer)
├── Program Input (assembly, binary)
├── Machine State (load/save JSON)
├── Display & Inspection (show opcodes, disassemble, aliases)
├── Verilog Generation (processor, RAM, ROM, testbench, FPGA targets)
└── Simulation & Execution (step-by-step vs fast run modes)

Follows documentation style established in cmd/simbox/README.md and cmd/bmstack/README.md.

Original prompt

This section details on the original issue you should resolve

<issue_title>procbuilder command readme docs. </issue_title>
<issue_description>Rewrite the Readme file of the procbuilder command in cmd/procbuilder/README.md</issue_description>

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


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 3 commits December 15, 2025 09:08
Co-authored-by: mmirko <7934656+mmirko@users.noreply.github.com>
Co-authored-by: mmirko <7934656+mmirko@users.noreply.github.com>
Co-authored-by: mmirko <7934656+mmirko@users.noreply.github.com>
Copilot AI changed the title [WIP] Rewrite README documentation for procbuilder command Rewrite procbuilder command README with comprehensive documentation Dec 15, 2025
Copilot AI requested a review from mmirko December 15, 2025 09:13
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.

procbuilder command readme docs.

2 participants