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

1.9 KiB

Raw Blame History

Installation

This guide covers installing the Mining Dashboard on your system.

Prerequisites

Go 1.21+ - For building the backend
Node.js 18+ - For building the frontend (optional, pre-built included)
Git - For cloning the repository

Quick Install

From Source

# Clone the repository
git clone https://github.com/Snider/Mining.git
cd Mining

# Build the CLI binary
make build

# The binary is now at ./miner-ctrl
./miner-ctrl --help

Build Commands

Command	Description
`make build`	Build the CLI binary
`make build-all`	Build for all platforms (Linux, macOS, Windows)
`make test`	Run tests with coverage
`make lint`	Run linters
`make docs`	Generate Swagger API documentation
`make dev`	Start development server

Platform-Specific Notes

Linux

No additional dependencies required. The miner binaries (XMRig, TT-Miner) will be automatically downloaded when you install them through the UI.

# Optional: Enable huge pages for better XMRig performance
sudo sysctl -w vm.nr_hugepages=1280

macOS

Works out of the box on both Intel and Apple Silicon.

Windows

Build with:

go build -o miner-ctrl.exe ./cmd/mining

Docker

# Build the image
docker build -t mining-dashboard .

# Run with persistent data
docker run -d \
  -p 9090:9090 \
  -v mining-data:/root/.local/share/lethean-desktop \
  -v mining-config:/root/.config/lethean-desktop \
  mining-dashboard

Verify Installation

# Check version
./miner-ctrl --version

# Run doctor to check system
./miner-ctrl doctor

# Start the server
./miner-ctrl serve

Then open http://localhost:9090 to access the dashboard.

Next Steps

Quick Start Guide - Get mining in 5 minutes
Configuration - Customize your setup

1.9 KiB Raw Blame History