docs: translate README to English
This commit is contained in:
@@ -1,60 +1,60 @@
|
||||
# Cursor Agent-Skills Setup
|
||||
|
||||
Dieses Projekt enthält Automatisierungsskripte, um die drei empfohlenen Agenten-Skills aus dem Repository [addyosmani/agent-skills](https://github.com/addyosmani/agent-skills) herunterzuladen und im Zielverzeichnis für Cursor (standardmäßig `.cursor/rules`) abzulegen.
|
||||
This project contains automation scripts to download the recommended agent skills from the [addyosmani/agent-skills](https://github.com/addyosmani/agent-skills) repository and place them in the target directory for Cursor (defaulting to `.cursor/rules`).
|
||||
|
||||
## Funktionsweise & Enthaltene Skills
|
||||
## How it Works & Included Skills
|
||||
|
||||
Die Skripte bieten eine interaktive Auswahl im Terminal, über die du jeden der 24 Skills aus dem Repository einzeln aktivieren oder deaktivieren kannst.
|
||||
The scripts provide an interactive selection menu in the terminal, allowing you to individually activate or deactivate any of the 24 skills from the repository.
|
||||
|
||||
* **Automatische Erkennung:** Die Skripte prüfen das Zielverzeichnis auf bereits vorhandene Skill-Dateien und wählen diese im Menü automatisch als aktiv aus.
|
||||
* **Standard-Skills:** Falls noch keine Skills im Zielverzeichnis existieren, sind die folgenden drei bewährten Best-Practice-Skills standardmäßig vorausgewählt:
|
||||
* **Auto-Detection:** The scripts scan the target directory for existing skill files and automatically mark them as active in the menu.
|
||||
* **Default Skills:** If no skills are currently present in the target directory, the following three best-practice skills are pre-selected by default:
|
||||
1. **Test-Driven Development** (`test-driven-development.md`)
|
||||
2. **Code Review and Quality** (`code-review-and-quality.md`)
|
||||
3. **Incremental Implementation** (`incremental-implementation.md`)
|
||||
* **Interaktive Steuerung:**
|
||||
* Eingabe einer **Zahl (1-24)** toggelt den entsprechenden Skill.
|
||||
* Eingabe von **`a`** wählt alle Skills aus.
|
||||
* Eingabe von **`n`** deaktiviert alle Skills.
|
||||
* Eingabe von **`d`** (oder einfach **Eingabetaste/Enter**) wendet die Auswahl an und startet den Download/Sync.
|
||||
* Eingabe von **`q`** bricht den Vorgang ohne Änderungen ab.
|
||||
* **Interactive Controls:**
|
||||
* Type a **number (1-24)** to toggle the corresponding skill.
|
||||
* Type **`a`** to select all skills.
|
||||
* Type **`n`** to deactivate all skills (clear selection).
|
||||
* Type **`d`** (or simply press **Enter**) to apply the changes and start the download/sync process.
|
||||
* Type **`q`** to quit/cancel without making any changes.
|
||||
|
||||
Nach Bestätigung werden alle aktivierten Skills heruntergeladen oder aktualisiert, und alle nicht (mehr) ausgewählten Skills werden automatisch aus dem Zielverzeichnis gelöscht.
|
||||
Once confirmed, all activated skills are downloaded or updated, and any skills that were not (or are no longer) selected are automatically deleted from the target directory.
|
||||
|
||||
Durch das Platzieren dieser Dateien im Ordner `.cursor/rules` deines Projekts werden diese Regeln automatisch in den Kontext des Cursor AI-Agenten geladen.
|
||||
By placing these files in the `.cursor/rules` folder of your project, Cursor's AI agent will automatically load them into its context.
|
||||
|
||||
---
|
||||
|
||||
## Verwendung
|
||||
## Usage
|
||||
|
||||
Die Skripte bieten ein interaktives Auswahlmenü direkt in deiner Shell, erstellen automatisch das Zielverzeichnis (falls noch nicht vorhanden) und laden die neuesten Versionen der ausgewählten Skills direkt aus dem GitHub-Repository herunter.
|
||||
The scripts provide an interactive selection menu directly in your shell, automatically create the target directory (if it does not exist), and download the latest versions of the chosen skills directly from the GitHub repository.
|
||||
|
||||
### Option 1: PowerShell (Windows)
|
||||
|
||||
1. Öffne die PowerShell im Hauptverzeichnis deines Zielprojekts.
|
||||
2. Führe das Skript aus:
|
||||
1. Open PowerShell in the root directory of your target project.
|
||||
2. Run the script:
|
||||
```powershell
|
||||
# Standard: Lädt die Skills in den Ordner '.cursor/rules' im aktuellen Verzeichnis
|
||||
# Default: Downloads skills to the '.cursor/rules' folder in the current directory
|
||||
& "C:\Users\mbusc\source\repos\cursor-skills-setup\setup-skills.ps1"
|
||||
|
||||
# Alternativ: Mit Angabe eines benutzerdefinierten Zielverzeichnisses
|
||||
& "C:\Users\mbusc\source\repos\cursor-skills-setup\setup-skills.ps1" -TargetDir "C:\dein\projekt\.cursor\rules"
|
||||
# Alternative: Specifying a custom target directory
|
||||
& "C:\Users\mbusc\source\repos\cursor-skills-setup\setup-skills.ps1" -TargetDir "C:\your\project\.cursor\rules"
|
||||
```
|
||||
|
||||
### Option 2: Bash (Linux / macOS / Git Bash)
|
||||
|
||||
1. Öffne das Terminal im Hauptverzeichnis deines Zielprojekts.
|
||||
2. Führe das Skript aus:
|
||||
1. Open the terminal in the root directory of your target project.
|
||||
2. Run the script:
|
||||
```bash
|
||||
# Standard: Lädt die Skills in den Ordner '.cursor/rules' im aktuellen Verzeichnis
|
||||
# Default: Downloads skills to the '.cursor/rules' folder in the current directory
|
||||
bash /c/Users/mbusc/source/repos/cursor-skills-setup/setup-skills.sh
|
||||
|
||||
# Alternativ: Mit Angabe eines benutzerdefinierten Zielverzeichnisses
|
||||
bash /c/Users/mbusc/source/repos/cursor-skills-setup/setup-skills.sh ./mein-zielordner
|
||||
# Alternative: Specifying a custom target directory
|
||||
bash /c/Users/mbusc/source/repos/cursor-skills-setup/setup-skills.sh ./my-custom-folder
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Voraussetzungen
|
||||
## Prerequisites
|
||||
|
||||
* **Bash-Skript**: Benötigt `curl` oder `wget`.
|
||||
* **PowerShell-Skript**: Benötigt mindestens PowerShell 3.0.
|
||||
* **Bash Script**: Requires `curl` or `wget`.
|
||||
* **PowerShell Script**: Requires at least PowerShell 3.0.
|
||||
|
||||
Reference in New Issue
Block a user