scroll/README.md

Justfile Quick Reference

🚀 Essential Commands

just setup          # First-time setup: create folders, check dependencies
just convert        # One-shot: setup + convert PDFs to video
just run            # Convert PDFs in inputs/ to video
just watch          # Play the output video
just clean          # Remove temporary files

📋 Workflow Examples

Basic Workflow

just setup                    # Setup project
# Copy PDFs to inputs/
just run                      # Create video
just watch                    # Watch result

Quick Convert

# Copy PDFs to inputs/
just convert                  # Does setup + run automatically

Using Presets

just configs                  # Create all preset configs
just run-config config_fast.yml      # 5 sec per slide
just run-config config_slow.yml      # 30 sec per slide, 60fps
just run-config config_landscape.yml # 1920x1080
just run-config config_hq.yml        # High quality, 60fps

🔍 Inspection Commands

just status         # Show PDFs, output, and temp file status
just info           # Show detailed video information
just check          # Check if inputs/ has PDFs
just disk           # Show disk usage

🧹 Cleanup Commands

just clean          # Remove tmp/ folder only
just clean-all      # Remove tmp/ AND output video

🎨 Preset Configurations

Command	Format	Speed	Use Case
config-portrait	1080x1920	Normal	Mobile/social media
config-landscape	1920x1080	Normal	Desktop/presentations
config-fast	1080x1920	Fast (5s)	Quick previews
config-slow	1080x1920	Slow (30s)	Detailed viewing
config-hq	1080x1920	Slow (20s, 60fps)	High quality

🛠️ Development Commands

just fmt            # Format code with black
just lint           # Lint code with pylint
just edit           # Open scroll.py in $EDITOR

💾 Backup & Sharing

just backup         # Backup current output to backups/
just archive        # Create tar.gz of project
just share          # Upload output to transfer.sh (temporary link)

🧪 Testing & Benchmarking

just test           # Run test with test.pdf (if exists)
just bench          # Measure processing time

📊 Information Commands

just help           # Show detailed help
just --list         # List all available commands
just ffmpeg-info    # Show FFmpeg version and codecs

💡 Tips

1. First time: Run just setup to check dependencies
2. Quick start: just convert does everything
3. Custom settings: Edit config.yml then just run
4. Multiple configs: Create presets with just configs
5. Space management: Run just clean after successful conversion

🎯 Common Scenarios

Scenario 1: Quick Social Media Video

just config-portrait
just run-config config_portrait.yml
# Upload output_portrait.mp4 to Instagram/TikTok

Scenario 2: Desktop Presentation

just config-landscape
just run-config config_landscape.yml
# Use output_landscape.mp4 in presentations

Scenario 3: Fast Preview

just config-fast
just run-config config_fast.yml
just watch
# If good, re-run with normal speed

Scenario 4: High Quality Production

just config-hq
just run-config config_hq.yml
# Takes longer but best quality

🆘 Troubleshooting

"command not found: just"

# Install just first
cargo install just
# or on Ubuntu/Debian
wget -qO - 'https://proget.makedeb.org/debian-feeds/prebuilt-mpr.pub' | gpg --dearmor | sudo tee /usr/share/keyrings/prebuilt-mpr-archive-keyring.gpg 1> /dev/null
echo "deb [signed-by=/usr/share/keyrings/prebuilt-mpr-archive-keyring.gpg] https://proget.makedeb.org prebuilt-mpr $(lsb_release -cs)" | sudo tee /etc/apt/sources.list.d/prebuilt-mpr.list
sudo apt update
sudo apt install just

"No PDF files found"

# Check inputs folder
just check
# Make sure PDFs are in inputs/
ls -la inputs/

"Missing dependencies"

just setup  # Shows what's missing
# Install as needed:
sudo apt install ffmpeg poppler-utils python3-pil python3-yaml

📖 Learn More

• Run just help for quick start guide
• Run just --list to see all commands
• Edit Justfile to customize commands
• Check README.md for detailed documentation