repo-readme-blueprint

Name: repo-readme-blueprint
Author: darthinvader

You create a top-level README that orients a writer.

by darthinvader(0) 0 installs

Free

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Prompt file imported from darthinvader/Creative-Writing (.github/prompts/repo-readme-blueprint.prompt.md). Copyright stays with the author.

---
mode: agent
description: 'Repository/Series README Blueprint: produce a top-level README optimized for a fantasy writing vault.'
---

You create a top-level README that orients a writer.

Clarify: single-book vs series, collaboration, and toolchain (plugins, themes).

Output:
- Reasoning (brief)
- Purpose & scope
- Folder map and key files
- How to draft, edit, and check canon with studio modes
- Contribution/branching guidance if collaborating
- Optional quick-start checklist
- Suggested file path: `README.md`

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

```prompt
---
mode: agent
description: 'Repository/Series README Blueprint: produce a top-level README optimized for a fantasy writing vault.'
---

You create a top-level README that orients a writer.

Clarify: single-book vs series, collaboration, and toolchain (plugins, themes).

Output:
- Reasoning (brief)
- Purpose & scope
- Folder map and key files
- How to draft, edit, and check canon with studio modes
- Contribution/branching guidance if collaborating
- Optional quick-start checklist
- Suggested file path: `README.md`

```

Manifest

The prompt text and its fill-in variables. Copy it or fetch it by URL from your own code.

darthinvader-creative-writing-repo-readme-blueprint-prompt.prompt.jsonjson

{
  "prompt": "```prompt\n---\nmode: agent\ndescription: 'Repository/Series README Blueprint: produce a top-level README optimized for a fantasy writing vault.'\n---\n\nYou create a top-level README that orients a writer.\n\nClarify: single-book vs series, collaboration, and toolchain (plugins, themes).\n\nOutput:\n- Reasoning (brief)\n- Purpose & scope\n- Folder map and key files\n- How to draft, edit, and check canon with studio modes\n- Contribution/branching guidance if collaborating\n- Optional quick-start checklist\n- Suggested file path: `README.md`\n\n```",
  "variables": [],
  "notes": "You create a top-level README that orients a writer.",
  "metadata": {
    "source": {
      "provider": "github-prompts",
      "repository": "https://github.com/darthinvader/Creative-Writing",
      "path": ".github/prompts/repo-readme-blueprint.prompt.md",
      "ref": "45fc2c7107d6779f62d39af2a1602fd8066c4ea6",
      "url": "https://github.com/darthinvader/Creative-Writing/blob/45fc2c7107d6779f62d39af2a1602fd8066c4ea6/.github/prompts/repo-readme-blueprint.prompt.md",
      "key": "darthinvader/Creative-Writing/.github/prompts/repo-readme-blueprint.prompt.md"
    }
  }
}

Fetch it by URL: GET /api/v1/registry/darthinvader-creative-writing-repo-readme-blueprint-prompt/manifest?version=1.0.0

About

Use it

Manifest

Reviews