Skip to content

[Docs] README quickstart command is missing Python version requirement #2135

@sora0218

Description

@sora0218

Component

Documentation

What happened?

The README quickstart section provides this install command:

curl -sSL https://rustchain.org/install.sh | bash

However, it does not mention any Python version requirement. RustChain's miner appears to use Python internally, but the README gives no indication of the minimum required version (e.g., Python 3.8+, 3.10+, etc.).

When a user with an older Python version (e.g., Python 3.7) runs the installer, they may encounter cryptic errors with no guidance on how to fix them, since the README doesn't document this prerequisite at all.

Steps to reproduce:

  1. Read the README quickstart section
    1. Run the install command on a system with Python < 3.8
    1. Receive an error with no hint that Python version is the issue
      Environment: macOS / Linux with Python 3.7 or older

Expected behavior

The README should state the minimum Python version required (e.g., "Requires Python 3.10+") near the quickstart install command, so users can verify compatibility before running the installer.

Steps to reproduce

  1. Read the README quickstart section (https://github.com/Scottcjn/Rustchain#readme)
    1. Note that no Python version is mentioned anywhere near the install command
    1. Run the install script on a system with Python 3.7 or older
    1. Encounter a cryptic installation error with no guidance

Version / Commit

No response

Operating System

None

Relevant logs

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions