docs: add English README for project-bootstrap; translate root README
- skills/project-bootstrap/README.md: new English README (modes, triggers, prerequisites, layout, install, see-also). - README.md: translated to English; both root READMEs cross-link. - README.ru.md: original Russian preserved (renamed from README.md); fixed broken `.wiki/source/repo-layout.md` link to point at the real path under `.wiki/concepts/`. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
67
README.md
67
README.md
@@ -1,64 +1,81 @@
|
||||
# claude-skills
|
||||
|
||||
Совместное хранилище и мастерская навыков для Claude.
|
||||
> Russian version: [README.ru.md](README.ru.md).
|
||||
|
||||
Joint workshop and storage for Claude skills.
|
||||
|
||||
## About
|
||||
|
||||
Здесь мы с Claude вместе разрабатываем, отлаживаем и храним скиллы:
|
||||
A shared workspace where Claude and I author, debug, and ship skills together:
|
||||
|
||||
- **`skills/`** — редактируемые исходники (markdown + ассеты), source of truth
|
||||
- **`dist/`** — собранные `.skill` архивы, закоммичены в репо
|
||||
- **`scripts/`** — утилиты: `build.sh` (исходник → `.skill`), `install.sh` (исходник → `~/.claude/skills/`)
|
||||
- **`.wiki/`**, **`.tasks/`** — рабочие материалы и доска задач
|
||||
- **`skills/`** — editable sources (markdown + assets), the source of truth
|
||||
- **`dist/`** — built `.skill` archives, committed to the repo
|
||||
- **`scripts/`** — utilities: `build.sh` (source → `.skill`), `install.sh` (source → `~/.claude/skills/`)
|
||||
- **`.wiki/`**, **`.tasks/`** — working notes and the task board
|
||||
|
||||
## Quick start
|
||||
|
||||
### Установить скиллы на новом компе
|
||||
### Install skills on a fresh machine
|
||||
|
||||
**Windows (PowerShell):**
|
||||
|
||||
```powershell
|
||||
git clone <repo> claude-skills
|
||||
cd claude-skills
|
||||
bash scripts/install.sh # copies every skills/* into ~/.claude/skills/
|
||||
# or only specific ones:
|
||||
bash scripts/install.sh caveman wiki-maintainer
|
||||
```
|
||||
|
||||
**Linux / macOS (bash):**
|
||||
|
||||
```bash
|
||||
git clone <repo> claude-skills
|
||||
cd claude-skills
|
||||
bash scripts/install.sh # копирует все skills/* в ~/.claude/skills/
|
||||
# или конкретные:
|
||||
bash scripts/install.sh # copies every skills/* into ~/.claude/skills/
|
||||
# or only specific ones:
|
||||
bash scripts/install.sh caveman wiki-maintainer
|
||||
```
|
||||
|
||||
Цель установки можно переопределить переменной `CLAUDE_SKILLS_DIR=/path bash scripts/install.sh`.
|
||||
The install target can be overridden with `CLAUDE_SKILLS_DIR=/path bash scripts/install.sh`.
|
||||
|
||||
### Отредактировать скилл
|
||||
> `install.sh` works on Windows under git-bash. A native `install.ps1` is on the task board but not yet implemented.
|
||||
|
||||
### Edit a skill
|
||||
|
||||
```bash
|
||||
# 1. Правишь skills/<name>/SKILL.md (или ассеты)
|
||||
# 2. Раскатываешь правки в живые скиллы:
|
||||
# 1. Edit skills/<name>/SKILL.md (or its assets).
|
||||
# 2. Push the changes into the live skill folder:
|
||||
bash scripts/install.sh <name>
|
||||
# 3. Пересобираешь архив (опц., но удобно делать перед коммитом):
|
||||
# 3. Rebuild the archive (optional, but handy before a commit):
|
||||
bash scripts/build.sh <name>
|
||||
```
|
||||
|
||||
### Собрать `.skill` архивы
|
||||
### Build `.skill` archives
|
||||
|
||||
```bash
|
||||
bash scripts/build.sh # все
|
||||
bash scripts/build.sh caveman # один
|
||||
bash scripts/build.sh # all skills
|
||||
bash scripts/build.sh caveman # one skill
|
||||
```
|
||||
|
||||
`build.sh` использует `zip` если он есть (Linux/macOS) или делегирует в
|
||||
`scripts/build.ps1` через PowerShell (Windows без `zip`). На Windows
|
||||
можно сразу запускать `powershell scripts/build.ps1`.
|
||||
`build.sh` uses `zip` when it's available (Linux/macOS) or delegates to
|
||||
`scripts/build.ps1` via PowerShell (Windows without `zip`). On Windows you
|
||||
can also run `powershell scripts/build.ps1` directly.
|
||||
|
||||
## Layout
|
||||
|
||||
```
|
||||
claude-skills/
|
||||
├── skills/ ← исходники (по папке на скилл)
|
||||
├── dist/ ← .skill архивы (коммитятся)
|
||||
├── skills/ ← sources (one folder per skill)
|
||||
├── dist/ ← .skill archives (committed)
|
||||
├── scripts/
|
||||
│ ├── build.sh / build.ps1
|
||||
│ └── install.sh
|
||||
├── .wiki/ ← дизайн-доки, заметки
|
||||
├── .wiki/ ← design docs, notes
|
||||
├── .tasks/ ← STATUS.md
|
||||
├── CLAUDE.md
|
||||
└── README.md
|
||||
└── README.md (this file — see README.ru.md for Russian)
|
||||
```
|
||||
|
||||
Подробнее про принципы и решения — в [`.wiki/source/repo-layout.md`](.wiki/source/repo-layout.md).
|
||||
For the principles and decisions behind this layout see
|
||||
[`.wiki/concepts/repo-layout.md`](.wiki/concepts/repo-layout.md).
|
||||
|
||||
Reference in New Issue
Block a user