Crucible Documentation

Welcome to the crucible documentation. This directory contains comprehensive documentation for the crucible 6502 simulator with Atari 8-bit BIOS emulation.

Documentation Index

User Documentation

User Guide - Complete user guide with examples
- Installation instructions
- Command-line options
- Device support
- File formats
- Troubleshooting

Developer Documentation

Architecture - Technical architecture and design
- System architecture overview
- Core components
- Memory map
- Device handlers
- Filesystem implementation
- Hardware emulation
- Callback system
API Reference - Complete API documentation
- Core simulator API
- Atari BIOS API
- ATR filesystem API
- Host filesystem API
- SIO API
- Data structures
- Code examples
Building Guide - Build system documentation
- Prerequisites
- Build options
- Platform-specific instructions
- Troubleshooting
- Advanced configuration

Project Information

Changelog - Version history and changes
Attributions - Credits and attributions

Quick Start

Build the project:
```
make
```

Run a program:

./build/crucible program.xex

Get help:

./build/crucible -h

Documentation Structure

docs/
├── README.md           # This file
├── USER_GUIDE.md       # User documentation
├── ARCHITECTURE.md     # Technical architecture
├── API_REFERENCE.md    # API documentation
├── BUILDING.md         # Build instructions
├── CHANGELOG.md        # Version history
└── ATTRIBUTIONS.md     # Credits

Getting Help

User Questions: See User Guide
Development Questions: See API Reference
Build Issues: See Building Guide
Architecture Questions: See Architecture

Contributing

When contributing to crucible:

Read the Architecture documentation
Follow the coding style
Update CHANGELOG.md with changes
Update ATTRIBUTIONS.md if needed
Update relevant documentation

License

See the main LICENSE file in the project root. All documentation is provided under the same license as the project (GPL v2 or later).