diff --git a/README.md b/README.md index 32e2ac8..f05d6e1 100644 --- a/README.md +++ b/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 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 ```bash -git clone https://github.com/sneak/prompts.git +git clone https://git.eeqj.de/sneak/prompts.git cd prompts ``` -Prompts are stored as Markdown files in the repository root. Copy or reference -them as needed in your projects. +Prompts are stored as Markdown files in `prompts/`. Copy or reference them as +needed in your projects. ## Rationale