Add Quick Start docs and branch-specific Docker builds
- README.md: Add Quick Start section with full build sequence - docker/README.md: Document branch-specific builds with git worktrees - docker/build.sh: Use branch name for COMPOSE_PROJECT_NAME - docker/docker-compose.yml: Remove hardcoded container_name Each branch now gets isolated Docker containers/volumes, enabling parallel development across git worktrees. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
38a01cac4d
commit
2b96d4ba21
4 changed files with 65 additions and 1 deletions
32
README.md
32
README.md
|
|
@ -2,6 +2,38 @@
|
|||
|
||||
Run KiCad PCBnew in the browser using WebAssembly.
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Full Build (KiCad + All Tests)
|
||||
|
||||
```bash
|
||||
# 1. Initialize submodules
|
||||
git submodule update --init --recursive
|
||||
|
||||
# 2. Build KiCad WASM (Docker, ~10 min incremental, ~1-2 hours full)
|
||||
./docker/build.sh
|
||||
|
||||
# 3. Build wxWidgets for local testing
|
||||
./scripts/build-wxuniversal-wasm.sh
|
||||
|
||||
# 4. Build wxWidgets test apps
|
||||
./scripts/build-wasm-test.sh
|
||||
|
||||
# 5. Run all tests
|
||||
cd tests && npm install
|
||||
npm test # wxWidgets tests (256 tests)
|
||||
npm run test:kicad # KiCad tests (2 tests)
|
||||
```
|
||||
|
||||
### wxWidgets Only (No Docker)
|
||||
|
||||
```bash
|
||||
# Requires: Emscripten SDK 4.0+, Node.js 18+
|
||||
./scripts/build-wxuniversal-wasm.sh
|
||||
./scripts/build-wasm-test.sh
|
||||
cd tests && npm install && npm test
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in a new issue