Add README.md
Initial commit with project description, getting started, rationale, design, and license information.
This commit is contained in:
commit
af257bef63
41
README.md
Normal file
41
README.md
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
# prompts
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/sneak/prompts.git
|
||||||
|
cd prompts
|
||||||
|
```
|
||||||
|
|
||||||
|
Prompts are stored as Markdown files in the repository root. Copy or
|
||||||
|
reference them as needed in your projects.
|
||||||
|
|
||||||
|
## Rationale
|
||||||
|
|
||||||
|
LLM prompts, especially development policies, benefit from version control
|
||||||
|
and a single authoritative source. This repo provides a central place to
|
||||||
|
maintain, share, and evolve prompts across projects.
|
||||||
|
|
||||||
|
## Design
|
||||||
|
|
||||||
|
The repository is a flat collection of Markdown files. Each file contains
|
||||||
|
one or more related prompts or policy documents. There is no build step or
|
||||||
|
runtime component; the prompts are consumed by copying them into other
|
||||||
|
projects or referencing them directly.
|
||||||
|
|
||||||
|
## TODO
|
||||||
|
|
||||||
|
- Add more prompt templates for common development tasks
|
||||||
|
- Add CI to lint Markdown
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT. See [LICENSE](LICENSE).
|
||||||
|
|
||||||
|
## Author
|
||||||
|
|
||||||
|
[@sneak](https://sneak.berlin)
|
||||||
Loading…
Reference in New Issue
Block a user