diff --git a/README.md b/README.md index bd8b117..6bbec8b 100644 --- a/README.md +++ b/README.md @@ -19,12 +19,27 @@ The app currently lets you test the core loop: ## Requirements -Host machine: +This project is intended to run inside a VS Code Dev Container. Your local desktop can be a thin client. + +Recommended setup: + +- Windows VM: runs VS Code and connects to the development machine over Remote SSH. +- Debian/Linux VM: hosts the repository, Docker, and the dev container. +- Dev container: provides the app toolchain. + +With this setup, the Windows VM does not need Node.js, .NET, SQLite, or Docker installed locally. Those tools run on the remote Debian VM or inside the dev container. + +Windows VM: -- Docker Desktop - Visual Studio Code +- VS Code Remote SSH extension - VS Code Dev Containers extension +Debian/Linux VM: + +- Docker Engine +- SSH access from the Windows VM + Provided inside the dev container: - Node.js LTS and npm @@ -33,7 +48,7 @@ Provided inside the dev container: ## Getting Started -Open the repo in VS Code and run: +From the Windows VM, connect to the Debian/Linux VM with VS Code Remote SSH. Open the repo on the remote machine, then run: ```text Dev Containers: Reopen in Container