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
This commit is contained in:
70
README.md
70
README.md
@@ -62,6 +62,76 @@ For detailed build and configuration status of all MCP/LSP servers, see [STATUS.
|
|||||||
docker compose up -d <service-name>
|
docker compose up -d <service-name>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### 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
|
## 💻 Usage
|
||||||
|
|
||||||
### Docker Compose Commands
|
### Docker Compose Commands
|
||||||
|
|||||||
Reference in New Issue
Block a user