Skip to content

docs: Add RustChain miner installation recording (Issue #1615)#3

Open
ma-moon wants to merge 3 commits intomainfrom
issue-1615-installation-gif
Open

docs: Add RustChain miner installation recording (Issue #1615)#3
ma-moon wants to merge 3 commits intomainfrom
issue-1615-installation-gif

Conversation

@ma-moon
Copy link
Owner

@ma-moon ma-moon commented Mar 12, 2026

Summary

This PR adds a complete installation recording for the RustChain miner as requested in issue Scottcjn#1615.

What's Included

  • installation.cast (25KB) - Complete asciinema recording (~2 minutes)
  • installation.svg (128KB) - Visual terminal session representation
  • install.sh - Automated installation script used in recording
  • README.md - Documentation with viewing instructions

Installation Steps Recorded

  1. ✅ Prerequisites check (Rust/Cargo verification)
  2. ✅ Repository cloning from GitHub
  3. ✅ Building with cargo build --release
  4. ✅ Binary verification
  5. ✅ Test run with --test-only flag
  6. ✅ Help documentation display

How to View

Locally with asciinema:

asciinema play docs/installation-recordings/1615/installation.cast

View SVG:

Open docs/installation-recordings/1615/installation.svg in a browser

Upload to asciinema.org:

asciinema upload docs/installation-recordings/1615/installation.cast

Testing

Recording was created on:

  • Rust: 1.94.0
  • Cargo: 1.94.0
  • OS: Linux (WSL2)
  • Duration: ~2 minutes

Related

Closes Scottcjn#1615


Bounty Claim: 2 RTC for installation GIF recording

龙虾机器人 and others added 3 commits March 13, 2026 00:40
- Add badges for open bounties and RTC pool
- Enhance Quick Start with bounty claim steps
- Expand bounty tiers table with USD values
- Add wallet setup guidance for newcomers
- Link CONTRIBUTING.md from README
- Improve navigation and discoverability

Helps new contributors find and claim bounties faster.
- Complete asciinema recording of installation process
- Step-by-step installation script (install.sh)
- SVG visualization of terminal session
- README with viewing instructions and installation commands

Recording demonstrates:
1. Prerequisites check (Rust/Cargo)
2. Repository cloning
3. Building with cargo build --release
4. Binary verification
5. Test run with --test-only flag
6. Help documentation

Files:
- installation.cast (25KB) - Asciinema recording
- installation.svg (128KB) - Visual representation
- install.sh - Automated installation script
- README.md - Documentation

Closes Scottcjn#1615
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[EASY BOUNTY: 2 RTC] Create installation GIFs or asciinema recordings

1 participant