update readme and remove requirements.txt
This commit is contained in:
parent
a67eb41523
commit
371ce03685
16
README.md
16
README.md
@ -22,6 +22,7 @@ This guide will help you set up a Model Context Protocol (MCP) server for KiCad.
|
|||||||
- macOS, Windows, or Linux
|
- macOS, Windows, or Linux
|
||||||
- Python 3.10 or higher
|
- Python 3.10 or higher
|
||||||
- KiCad 9.0 or higher
|
- KiCad 9.0 or higher
|
||||||
|
- uv 0.8.0 or higher
|
||||||
- Claude Desktop (or another MCP client)
|
- Claude Desktop (or another MCP client)
|
||||||
|
|
||||||
## Installation Steps
|
## Installation Steps
|
||||||
@ -32,14 +33,15 @@ First, let's install dependencies and set up our environment:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Clone the repository
|
# Clone the repository
|
||||||
git clone https://github.com/lamaalrajih/kicad-mcp.git .
|
git clone https://github.com/lamaalrajih/kicad-mcp.git
|
||||||
|
cd kicad-mcp
|
||||||
|
|
||||||
# Create a virtual environment and activate it
|
# Install dependencies – `uv` will create a `.venv/` folder automatically
|
||||||
python3 -m venv venv
|
# (Install `uv` first: `brew install uv` on macOS or `pipx install uv`)
|
||||||
source venv/bin/activate # On Windows: venv\Scripts\activate
|
make install
|
||||||
|
|
||||||
# Install the MCP SDK and other dependencies
|
# Optional: activate the environment for manual commands
|
||||||
pip install -r requirements.txt
|
source .venv/bin/activate
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Configure Your Environment
|
### 2. Configure Your Environment
|
||||||
@ -89,7 +91,7 @@ vim ~/Library/Application\ Support/Claude/claude_desktop_config.json
|
|||||||
{
|
{
|
||||||
"mcpServers": {
|
"mcpServers": {
|
||||||
"kicad": {
|
"kicad": {
|
||||||
"command": "/ABSOLUTE/PATH/TO/YOUR/PROJECT/kicad-mcp/venv/bin/python",
|
"command": "/ABSOLUTE/PATH/TO/YOUR/PROJECT/kicad-mcp/.venv/bin/python",
|
||||||
"args": [
|
"args": [
|
||||||
"/ABSOLUTE/PATH/TO/YOUR/PROJECT/kicad-mcp/main.py"
|
"/ABSOLUTE/PATH/TO/YOUR/PROJECT/kicad-mcp/main.py"
|
||||||
]
|
]
|
||||||
|
@ -1,12 +0,0 @@
|
|||||||
mcp[cli]
|
|
||||||
pandas
|
|
||||||
|
|
||||||
# Development/Testing
|
|
||||||
pytest
|
|
||||||
pytest-asyncio
|
|
||||||
pytest-mock
|
|
||||||
pytest-cov
|
|
||||||
pytest-xdist
|
|
||||||
ruff
|
|
||||||
mypy
|
|
||||||
pre-commit
|
|
Loading…
x
Reference in New Issue
Block a user