Files
alkane-os/README.md
T
noah 3ab9d1a4bf
main-release-gate / verify-and-release (push) Failing after 4s
next-build / build (push) Successful in 4s
Initialize Alkane OS target matrix and release gates
2026-10-13 11:13:39 -06:00

1.5 KiB

Alkane OS

Portable mining, tuning, and management logic for Alkane control boards. The source is MIT licensed. alkane-sdk owns the board images and supplies the hardware backend at build time. This repository has no on-board web frontend; the intended management surfaces are SSH, cgminer-compatible port 4028, and a minimal API.

Status

This is the initial interface and release tooling. It does not mine yet. A target in the matrix is an obligation to implement and validate, not a claim of support. All 64 theoretical same-vendor controller/chip pairings are in scope: 52 Bitmain and 12 WhatsMiner. For pairings a stock image rejects, the simulator must record the first genuine rejection gate and Alkane OS must mine. No live board is required by CI. Bench devices supply captures and independent validation of the simulator.

The main branch has full tests and a conformance gate; releases are created only after every required cell passes. next runs a build check and produces release candidates. ci/version-x.txt is the manually edited major version. For this repository, Y changes when the mining protocol, HAL contract, tuning policy or API changes; Z changes for compatible fixes and packaging updates.

Local checks

cargo fmt --check
cargo clippy --all-targets -- -D warnings
cargo test
python3 ci/check-conformance.py

The last command currently fails because simulator and device evidence are still pending. It is a release gate, not a unit test.