Skip to content

Commit 63e1839

Browse files
committed
docs: fix broken formatting and commands in README
1 parent 7b51c8b commit 63e1839

1 file changed

Lines changed: 12 additions & 8 deletions

File tree

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,28 +37,29 @@ GitHub Copilot Starter is a template repository for configuring, customizing, an
3737
- **Specification-driven workflow**: Optionally use the included workflow for requirements, design, implementation, and validation
3838
- **No fixed tech stack**: Adapt to any language, framework, or toolchain
3939

40-
## Project Stskills/` — Agent Skills (dynamically loaded when relevant)
40+
## Project Structure
4141

42+
- `.github/skills/` — Agent Skills (dynamically loaded when relevant)
4243
- `.github/instructions/` — Custom instructions (always active, universal principles)
4344
- `.github/prompts/` — Custom prompts for specific workflows
44-
45-
- `.github/instructions/` — Core instruction files (edit or add your own)
4645
- `/src`, `/tests`, `/public`, `/config`, `/docs` — Example folders for typical projects (customize or remove as needed)
4746

4847
## Getting Started
4948

5049
1. **Clone the repository**
5150
```zsh
5251
git clone https://github.com/devbyrayray/github-copilot-starter.git
53-
cd github-copilot-starskills and instructions**
52+
cd github-copilot-starter
53+
```
54+
2. **Review skills and instructions**
5455
- Browse Agent Skills in `.github/skills/` for language/framework-specific standards
5556
- Edit custom instructions in `.github/instructions/` for universal principles
5657
- Customize prompts in `.github/prompts/` for specific workflows
57-
```
58-
2. **Integrate with your project**
58+
59+
3. **Integrate with your project**
5960
- Copy or merge the skills, instructions, and prompts into your own repository
6061
- Adjust folder structure as needed for your tech stack
61-
3. Agent Skills (Dynamic Loading)
62+
## Agent Skills (Dynamic Loading)
6263

6364
Agent Skills are modular, discoverable instructions that AI agents load dynamically based on the task at hand. Skills are located in `.github/skills/` and follow the [Agent Skills specification](https://agentskills.io/specification).
6465

@@ -100,8 +101,11 @@ Universal principles and guidelines that apply to all code are located in `.gith
100101
- [Configuration](.github/instructions/config.instructions.md) - Configuration file standards
101102
- [Project Structure](.github/instructions/project-file-structure.instructions.md) - Repository organization
102103
- [Tooling](.github/instructions/tools.instructions.md) - Development tools and workflows
104+
- [Testing & TDD](.github/instructions/testing.instructions.md) - Testing strategies and TDD
105+
- [Markdown Standards](.github/instructions/markdown.instructions.md) - Documentation standards
106+
- [Nuxt.js Standards](.github/instructions/nuxt.instructions.md) - Nuxt.js specific guidelines
103107

104-
These instructions remain as custom instructions because they contain universal architecture patterns that should always be considered. - Nuxt.js standards ([nuxt.instructions.md](.github/instructions/nuxt.instructions.md)) - Markdown standards ([markdown.instructions.md](.github/instructions/markdown.instructions.md)) - Project structure ([project-file-structure.instructions.md](.github/instructions/project-file-structure.instructions.md)) - Security ([security.instructions.md](.github/instructions/security.instructions.md)) - Testing & TDD ([testing.instructions.md](.github/instructions/testing.instructions.md)) - Tooling ([tools.instructions.md](.github/instructions/tools.instructions.md))- Add, remove, or modify instructions to fit your project
108+
Add, remove, or modify instructions to fit your project.
105109

106110
## Custom Prompts
107111

0 commit comments

Comments
 (0)