Skip to content
  • YeonGyu-Kim's avatar
    71f5f83a
    feat: #153 — add post-build binary location and verification guide to README · 71f5f83a
    YeonGyu-Kim authored
    ## Problem
    
    Users frequently ask after building:
    - "Where is the claw binary?"
    - "Did the build actually work?"
    - "Why can't I run \`claw\` from anywhere?"
    
    This happens because \`cargo build\` puts the binary in \`rust/target/debug/claw\`
    (or \`rust/target/release/claw\`), and new users don't know:
    1. Where to find it
    2. How to test it
    3. How to add it to PATH (optional but common follow-up)
    
    ## Fix
    
    Added new section "Post-build: locate the binary and verify" to README covering:
    
    1. **Binary location table:** debug vs. release, macOS/Linux vs. Windows paths
    2. **Verification commands:** Test the binary with \`--help\` and \`doctor\`
    3. **Three ways to add to PATH:**
       - Symlink (macOS/Linux): \`ln -s ... /usr/local/bin/claw\`
       - cargo install: \`cargo install --path . --force\`
       - Shell profile update: add rust/target/debug to \$PATH
    4. **Troubleshooting:** Common errors ("command not found", "permission denied",
       debug vs. release build speed)
    
    ## Impact
    
    New users can now:
    - Find the binary immediately after build
    - Run it and verify with \`claw doctor\`
    - Know their options for system-wide access
    
    Also filed ROADMAP #153 documenting the gap.
    
    Closes ROADMAP #153.
    71f5f83a
    feat: #153 — add post-build binary location and verification guide to README
    YeonGyu-Kim authored
    ## Problem
    
    Users frequently ask after building:
    - "Where is the claw binary?"
    - "Did the build actually work?"
    - "Why can't I run \`claw\` from anywhere?"
    
    This happens because \`cargo build\` puts the binary in \`rust/target/debug/claw\`
    (or \`rust/target/release/claw\`), and new users don't know:
    1. Where to find it
    2. How to test it
    3. How to add it to PATH (optional but common follow-up)
    
    ## Fix
    
    Added new section "Post-build: locate the binary and verify" to README covering:
    
    1. **Binary location table:** debug vs. release, macOS/Linux vs. Windows paths
    2. **Verification commands:** Test the binary with \`--help\` and \`doctor\`
    3. **Three ways to add to PATH:**
       - Symlink (macOS/Linux): \`ln -s ... /usr/local/bin/claw\`
       - cargo install: \`cargo install --path . --force\`
       - Shell profile update: add rust/target/debug to \$PATH
    4. **Troubleshooting:** Common errors ("command not found", "permission denied",
       debug vs. release build speed)
    
    ## Impact
    
    New users can now:
    - Find the binary immediately after build
    - Run it and verify with \`claw doctor\`
    - Know their options for system-wide access
    
    Also filed ROADMAP #153 documenting the gap.
    
    Closes ROADMAP #153.
Loading