Getting Started

Getting Started

Expands README's Requirements & installation / Quick start into a friendlier, more thorough walkthrough for first-time users.

Outline

• Prerequisites
  • Ruby 3.2+ / WSL2 / Microsoft WSLC
  • Confirming wslc itself is installed (the wslc.exe / wslc / System32 lookup order)
• Installation
  • gem install wslc-wip
  • Installing from source (bundle install && bundle exec exe/wip version)
  • Checking the version (wip version)
• First steps
  • Generate wip.yml with wip init (when to use --template rails|node|rust|csharp)
  • How compose-native gets auto-selected when a compose.yml is found nearby
  • Filling in the generated wip.yml's TODOs
• Verifying it works
  • wip doctor diagnostics (what triggers OK/WARN/FAIL)
  • The wip build → wip up -d → wip <interaction-name> flow
• Where to go next
  • Not sure which mode to use? → Concepts
  • Want the full wip.yml key list? → Configuration Reference
  • Boot feels slow? → Guides#fixing-a-slow-boot