Skip to content

README quickstart dry-run command does not match install-miner.sh path #3973

@godd-ctrl

Description

@godd-ctrl

Summary

The root README quickstart currently tells newcomers to run this sequence:

curl -sSL https://raw.githubusercontent.com/Scottcjn/Rustchain/main/install-miner.sh | bash
rustchain-miner --dry-run

But install-miner.sh downloads the Python miner into ~/.rustchain, creates ~/.rustchain/start.sh, and optionally installs a user service. It does not appear to install a rustchain-miner executable on PATH. A newcomer following the README exactly may get command not found after the installer succeeds.

Where I saw it

  • README.md Quickstart section, lines around 260-264
  • install-miner.sh, which creates ~/.rustchain/start.sh and runs rustchain_miner.py
  • START_HERE.md, which points current users toward clawrtc install, clawrtc start, clawrtc status, and clawrtc logs

Expected

The README dry-run example should match the installer path, for example:

curl -sSL https://raw.githubusercontent.com/Scottcjn/Rustchain/main/install-miner.sh | bash -s -- --dry-run

or it should explain that rustchain-miner --dry-run is for the Rust binary/Homebrew path, not the one-line Python installer path.

Actual

The README mixes the one-line Python installer with the Rust binary command, which is confusing for first-time users trying the safe dry-run path.

Environment

Fresh clone review on Windows/PowerShell; issue found by reading the root README and installer script.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions