Commit Graph

5 Commits

Author SHA1 Message Date
sleepy 1788087145 Add comprehensive documentation
Create docs/GUIDE.md with complete documentation:
- Quick Start Guide for all platforms
- Opencode configuration examples:
  - Basic configuration
  - Remote machine setup
  - Multiple model options
  - Environment-specific configs
  - Testing instructions
- API Reference:
  - All OpenAI-compatible endpoints
  - Federation endpoints
  - Request/response examples
- Troubleshooting Guide:
  - Common issues and solutions
  - Platform-specific problems
  - Installation issues
- Advanced Configuration:
  - config.yaml options
  - Environment variables
- Performance Tuning:
  - Speed vs quality settings
  - Memory usage tables
  - Recommended configurations
- MCP Server setup and usage
- Network Federation guide

Update README.md:
- Add Documentation section with links
- Reference the complete guide

Documentation now covers:
 Installation all platforms
 Opencode integration
 API usage
 Troubleshooting
 Performance optimization
 Advanced features
2026-02-23 18:39:56 +01:00
sleepy b9669e415d Update README with interactive menu documentation
- Add interactive mode section with screenshots
- Document the 3 menu options (recommended, browse, custom)
- Add startup summary section showing what info is displayed
- Add interactive features and MCP server to features list
- Document --auto flag to skip menu
- Add hardware/resource usage display examples
2026-02-23 17:44:44 +01:00
sleepy d3d2c50c71 Update README with MCP server documentation
- Add MCP Server section explaining the --mcp flag
- Document the 5 MCP tools available to AI assistants
- Add --mcp to CLI Options section
- Explain benefits of MCP integration for automatic hardware queries
2026-02-23 17:38:48 +01:00
sleepy 1940b40be5 Update documentation: Add network federation, extended GPU support, and Android
PLAN.md updates:
- Add Phase 6: Local Network Federation with mDNS discovery
- Add Phase 7: Extended GPU support (AMD, Intel, Qualcomm)
- Update architecture diagram with network modules
- Add federation architecture diagram
- Update test coverage for all platforms

README.md updates:
- Add network federation features and configuration
- Add hardware support for AMD, Intel, Qualcomm GPUs
- Add Android/Termux installation instructions
- Update hardware detection section
- Update supported models table with more hardware examples
- Add federated swarm architecture diagram
- Add troubleshooting for AMD, Intel, Android
- Update acknowledgments with new dependencies

New todos added for:
- Network federation implementation
- AMD GPU support (ROCm)
- Intel GPU support (OneAPI)
- Android/Termux support
2026-02-23 17:05:59 +01:00
sleepy 8cf1e16703 Initial commit: Local Swarm project structure and documentation 2026-02-23 16:46:31 +01:00