Add quick start one-liners to README
Copy-pasteable commands to bring an existing repo up to standards or start a new repo from scratch using Claude Code.
This commit is contained in:
parent
d523ff37ae
commit
7f4ed7edbd
20
README.md
20
README.md
@ -4,15 +4,29 @@ prompts is an MIT-licensed collection of LLM prompts by
|
|||||||
[@sneak](https://sneak.berlin), including development policy prompts and other
|
[@sneak](https://sneak.berlin), including development policy prompts and other
|
||||||
useful prompts for working with large language models.
|
useful prompts for working with large language models.
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
Bring an existing repo up to standards (run from within the repo):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
P=$(mktemp -d) && git clone --depth 1 https://git.eeqj.de/sneak/prompts.git "$P" && claude "Read $P/prompts/REPO_POLICIES.md and $P/prompts/EXISTING_REPO_CHECKLIST.md, then bring this repo up to those standards."
|
||||||
|
```
|
||||||
|
|
||||||
|
Start a new repo from scratch:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
P=$(mktemp -d) && git clone --depth 1 https://git.eeqj.de/sneak/prompts.git "$P" && claude "Read $P/prompts/REPO_POLICIES.md and $P/prompts/NEW_REPO_CHECKLIST.md, then set up this new repo according to those standards."
|
||||||
|
```
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/sneak/prompts.git
|
git clone https://git.eeqj.de/sneak/prompts.git
|
||||||
cd prompts
|
cd prompts
|
||||||
```
|
```
|
||||||
|
|
||||||
Prompts are stored as Markdown files in the repository root. Copy or reference
|
Prompts are stored as Markdown files in `prompts/`. Copy or reference them as
|
||||||
them as needed in your projects.
|
needed in your projects.
|
||||||
|
|
||||||
## Rationale
|
## Rationale
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user