From 49256e20fac268155e3c5ebf49e70470af9e2a9b Mon Sep 17 00:00:00 2001 From: Charles N Wyble Date: Wed, 21 Jan 2026 19:39:35 -0500 Subject: [PATCH] docs: Add setup scripts documentation to README.md Added sections: - Setup Scripts documentation (CloneVendorRepos.sh, BuildAll.sh, CleanVendor.sh, StatusCheck.sh) - Makefile targets documentation with examples - Clarification that vendor/ directory is gitignored and created automatically Note: Updated Quick Start section to include information about setup scripts and Makefile targets --- README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) diff --git a/README.md b/README.md index 9a52bf3..df1edad 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,76 @@ For detailed build and configuration status of all MCP/LSP servers, see [STATUS. docker compose up -d ``` +### Setup Scripts + +The repository includes helpful scripts to simplify setup and management: + +#### CloneVendorRepos.sh +Clone all upstream vendor MCP/LSP repositories: + +```bash +./CloneVendorRepos.sh +``` + +This script clones all 27 vendor repositories into `vendor/` directory. + +#### BuildAll.sh +Build all MCP/LSP services: + +```bash +./BuildAll.sh +``` + +This script iterates through all services in `docker-compose.yml` and builds each one. + +#### CleanVendor.sh +Remove all cloned vendor repositories: + +```bash +./CleanVendor.sh +``` + +⚠️ **Warning**: This permanently deletes all cloned vendor repositories. You'll need to re-clone them. + +#### StatusCheck.sh +Check build status of all services: + +```bash +./StatusCheck.sh +``` + +This script checks which Docker images exist and compares with `STATUS.md`. + +### Makefile Targets + +For a more command-line oriented approach, use the included Makefile: + +```bash +# Show all available targets +make help + +# Clone all vendor repositories +make clone-vendors + +# Build all services +make build-all + +# Clean vendor directory +make clean-vendor + +# Check service status +make status + +# Start all services +make up + +# Stop all services +make down + +# Rebuild specific service +make rebuild SERVICE=context7-mcp +``` + ## 💻 Usage ### Docker Compose Commands