docs: fix inaccurate miner instructions in START_HERE.md (#723)#759
Merged
Scottcjn merged 1 commit intoScottcjn:mainfrom Mar 9, 2026
Merged
Conversation
Replace outdated cargo build instructions with verified Python miner commands: one-line installer and manual run options. Add systemd/launchd management commands for Linux and macOS. diff --git a/START_HERE.md b/START_HERE.md index 9652a80..f23a75a 100644 --- a/START_HERE.md +++ b/START_HERE.md @@ -60,20 +60,44 @@ Earn RTC by contributing compute resources. ### Requirements -- Linux (recommended) or Windows +- Linux (recommended), macOS, or Windows - 4GB+ RAM - GPU recommended (4GB+ VRAM) for better rewards ### Start Mining +**Recommended: One-line installer** + +```bash +# Install and start miner (auto-configures systemd/launchd) +curl -sSL https://raw.githubusercontent.com/Scottcjn/Rustchain/main/install-miner.sh | bash -s -- --wallet YOUR_WALLET +``` + +**Alternative: Manual run** + ```bash -# Install -git clone https://github.com/Scottcjn/Rustchain -cd Rustchain -cargo build --release +# Download miner scripts +mkdir -p ~/.rustchain && cd ~/.rustchain +curl -sSL https://raw.githubusercontent.com/Scottcjn/Rustchain/main/miners/linux/rustchain_linux_miner.py -o rustchain_miner.py +curl -sSL https://raw.githubusercontent.com/Scottcjn/Rustchain/main/miners/linux/fingerprint_checks.py -o fingerprint_checks.py # Run miner -./target/release/rustchain-miner --wallet YOUR_WALLET +python3 rustchain_miner.py --wallet YOUR_WALLET +``` + +### Manage Miner + +```bash +# Linux (systemd user service) +systemctl --user status rustchain-miner # Check status +systemctl --user stop rustchain-miner # Stop mining +systemctl --user start rustchain-miner # Start mining +journalctl --user -u rustchain-miner -f # View logs + +# macOS (launchd) +launchctl list | grep rustchain # Check status +launchctl unload ~/Library/LaunchAgents/com.rustchain.miner.plist # Stop +launchctl load ~/Library/LaunchAgents/com.rustchain.miner.plist # Start ``` ### Check Rewards
github-actions
Bot
added
documentation
createkr
pushed a commit
to createkr/Rustchain
that referenced
this pull request
Mar 12, 2026
Implement RSS 2.0, Atom 1.0, and JSON Feed endpoints for BoTTube video content. Changes: - node/bottube_feed.py: Feed generation module with RSS/Atom builders - node/bottube_feed_routes.py: Flask API routes for feed endpoints - node/rustchain_v2_integrated_v2.2.1_rip200.py: Feed route integration - sdk/python/rustchain_sdk/bottube/client.py: SDK feed methods (feed_rss, feed_atom, feed_json) - docs/BOTTUBE_FEED.md: Comprehensive documentation - tests/test_bottube_feed.py: Feed generator unit tests (32 tests) - tests/test_bottube_feed_routes.py: API route tests (23 tests) Features: - GET /api/feed/rss - RSS 2.0 feed with media extensions - GET /api/feed/atom - Atom 1.0 feed with full metadata - GET /api/feed - JSON Feed with auto-discovery links - Agent filtering (?agent=agent-id) - Pagination (?limit=N, ?cursor=token) - XML escaping and security hardening - Cache headers (5-minute TTL) All 55 tests pass.
createkr
added a commit
to createkr/Rustchain
that referenced
this pull request
Mar 22, 2026
…tcjn#759) Replace outdated cargo build instructions with verified Python miner commands: one-line installer and manual run options. Add systemd/launchd management commands for Linux and macOS. diff --git a/START_HERE.md b/START_HERE.md index 9652a80..f23a75a 100644 --- a/START_HERE.md +++ b/START_HERE.md @@ -60,20 +60,44 @@ Earn RTC by contributing compute resources. ### Requirements -- Linux (recommended) or Windows +- Linux (recommended), macOS, or Windows - 4GB+ RAM - GPU recommended (4GB+ VRAM) for better rewards ### Start Mining +**Recommended: One-line installer** + +```bash +# Install and start miner (auto-configures systemd/launchd) +curl -sSL https://raw.githubusercontent.com/Scottcjn/Rustchain/main/install-miner.sh | bash -s -- --wallet YOUR_WALLET +``` + +**Alternative: Manual run** + ```bash -# Install -git clone https://github.com/Scottcjn/Rustchain -cd Rustchain -cargo build --release +# Download miner scripts +mkdir -p ~/.rustchain && cd ~/.rustchain +curl -sSL https://raw.githubusercontent.com/Scottcjn/Rustchain/main/miners/linux/rustchain_linux_miner.py -o rustchain_miner.py +curl -sSL https://raw.githubusercontent.com/Scottcjn/Rustchain/main/miners/linux/fingerprint_checks.py -o fingerprint_checks.py # Run miner -./target/release/rustchain-miner --wallet YOUR_WALLET +python3 rustchain_miner.py --wallet YOUR_WALLET +``` + +### Manage Miner + +```bash +# Linux (systemd user service) +systemctl --user status rustchain-miner # Check status +systemctl --user stop rustchain-miner # Stop mining +systemctl --user start rustchain-miner # Start mining +journalctl --user -u rustchain-miner -f # View logs + +# macOS (launchd) +launchctl list | grep rustchain # Check status +launchctl unload ~/Library/LaunchAgents/com.rustchain.miner.plist # Stop +launchctl load ~/Library/LaunchAgents/com.rustchain.miner.plist # Start ``` ### Check Rewards Co-authored-by: createkr <createkr@proton.me>
Owner
|
Transfer confirmed — this was included in the batch settlement of 1,091 RTC to @createkr's wallet. |
Contributor
This was referenced May 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes issue #723 with corrected miner installation and operation instructions in START_HERE.md. Scope is docs-only and focused.