Snider/Mining
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Mining/docs
History
snider 69376b886f feat: Rebrand xmrig to miner and vendor XMRig ecosystem 
Complete rebranding of all components:
- Core miner: xmrig -> miner (binary, version.h, CMakeLists.txt)
- Proxy: xmrig-proxy -> miner-proxy
- CUDA plugin: xmrig-cuda -> miner-cuda
- Heatmap: xmrig-nonces-heatmap -> miner-nonces-heatmap
- Go CLI wrapper: miner-cli -> miner-ctrl

Vendored XMRig ecosystem into miner/ directory:
- miner/core - XMRig CPU/GPU miner
- miner/proxy - Stratum proxy
- miner/cuda - NVIDIA CUDA plugin
- miner/heatmap - Nonce visualization tool
- miner/config - Configuration UI
- miner/deps - Pre-built dependencies

Updated dev fee to use project wallet with opt-out (kMinimumDonateLevel=0)
Updated branding to Lethean (domain, copyright, version 0.1.0)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-30 19:43:02 +00:00
..
00-START-HERE.md feat: Add multi-miner dashboard support and TT-Miner implementation 2025-12-27 22:48:20 +00:00
API.md feat: Rebrand xmrig to miner and vendor XMRig ecosystem 2025-12-30 19:43:02 +00:00
ARCHITECTURE.md Add descriptive markdown documentation to docs folder 2025-11-25 00:03:35 +00:00
CLI.md feat: Rebrand xmrig to miner and vendor XMRig ecosystem 2025-12-30 19:43:02 +00:00
DEVELOPMENT.md Add descriptive markdown documentation to docs folder 2025-11-25 00:03:35 +00:00
docs.go feat: Implement logging functionality for miners with log buffer and retrieval endpoint 2025-12-29 22:10:45 +00:00
FILES-INDEX.md feat: Add multi-miner dashboard support and TT-Miner implementation 2025-12-27 22:48:20 +00:00
MANIFEST.md feat: Add multi-miner dashboard support and TT-Miner implementation 2025-12-27 22:48:20 +00:00
pool-integration-guide.md feat: Add multi-miner dashboard support and TT-Miner implementation 2025-12-27 22:48:20 +00:00
POOL-RESEARCH-README.md feat: Add multi-miner dashboard support and TT-Miner implementation 2025-12-27 22:48:20 +00:00
pool-research.md feat: Add multi-miner dashboard support and TT-Miner implementation 2025-12-27 22:48:20 +00:00
QUICK-REFERENCE.md feat: Add multi-miner dashboard support and TT-Miner implementation 2025-12-27 22:48:20 +00:00
README.md Add descriptive markdown documentation to docs folder 2025-11-25 00:03:35 +00:00
RESEARCH-SUMMARY.txt feat: Add multi-miner dashboard support and TT-Miner implementation 2025-12-27 22:48:20 +00:00
swagger.json feat: Implement logging functionality for miners with log buffer and retrieval endpoint 2025-12-29 22:10:45 +00:00
swagger.yaml feat: Implement logging functionality for miners with log buffer and retrieval endpoint 2025-12-29 22:10:45 +00:00
xmr-pools-database.json feat: Add multi-miner dashboard support and TT-Miner implementation 2025-12-27 22:48:20 +00:00

README.md

Mining Documentation

Welcome to the documentation for the Mining project. This folder contains detailed information about the API, CLI, architecture, and development processes.

Documentation Index

  • API Documentation: Detailed information about the RESTful API endpoints, request/response formats, and Swagger usage.
  • CLI Documentation: A comprehensive guide to the Command Line Interface, including command descriptions and usage examples.
  • Architecture Guide: An overview of the project's design, including the modular ManagerInterface, core packages, and data flow.
  • Development Guide: Instructions for contributors on how to build, test, and release the project.

Quick Start

For a quick start guide, please refer to the main README.md in the project root.