docs: add root monorepo README

This commit is contained in:
Matt Bruce 2026-02-19 12:37:30 -06:00
parent 6a398ac367
commit ce0ad50ac1

69
README.md Normal file
View File

@ -0,0 +1,69 @@
# OpenClaw Setups Monorepo
This repository contains two OpenClaw setup variants:
- `openclaw-setup-max/`: Local + paid model workflow (manual/scheduled paid/free switching, Ollama fallback, budget guard).
- `openclaw-setup-copilot/`: Copilot-first workstation template (Copilot guardrails, profile scheduling, auth/policy watchdogs).
## Which Folder Should I Use?
- Use `openclaw-setup-max/` if you want a local-first setup with optional paid model usage.
- Use `openclaw-setup-copilot/` if the target machine should run primarily on a Copilot account with strict guardrails.
## Quick Start
### Max setup
```bash
cd /Volumes/Data/openclaw-setups/openclaw-setup-max
cat README.md
```
Primary docs:
- `openclaw-setup-max/README.md`
- `openclaw-setup-max/PRD.md`
### Copilot setup
```bash
cd /Volumes/Data/openclaw-setups/openclaw-setup-copilot
cat README.md
```
Primary docs:
- `openclaw-setup-copilot/README.md`
- `openclaw-setup-copilot/PRD.md`
- `openclaw-setup-copilot/docs/operations/AI_SETUP_HANDOFF.md`
- `openclaw-setup-copilot/docs/operations/WORK_SETUP_CHECKLIST.md`
## Repository Structure
- `openclaw-setup-max/`
- `openclaw-setup-copilot/`
Inside each setup folder:
- `AGENTS.md`: runtime/agent rules for that setup
- `README.md`: operator guide
- `PRD.md`: requirements and design intent
- `setup/`: bootstrap scripts
- `scripts/`: daily operations and guard installers
- `config/`: editable JSON policies/profiles/schedules
- `docs/context/`: persona and context files
- `docs/operations/`: runbooks and troubleshooting
- `memory/`: retained session notes
## Git Workflow
- Default collaboration branch: `develop`
- Current remote: `origin` (`ssh://git@192.168.1.128:220/TopDogLabs/OpenClaw-Setup.git`)
Standard flow:
```bash
git checkout develop
git pull --rebase
# make changes
git add .
git commit -m "your message"
git push
```