Skip to content

docs: Format speckit commands in README to fit in mobile screens #2500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mr-Saxobeat wants to merge 1 commit into
base: main
Choose a base branch
from
+31 −3
Open

docs: Format speckit commands in README to fit in mobile screens #2500

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 31 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,23 +131,51 @@ Launch your coding agent in the project directory. Most agents expose spec-kit a
Use the **`/speckit.constitution`** command to create your project's governing principles and development guidelines that will guide all subsequent development.

```bash
/speckit.constitution Create principles focused on code quality, testing standards, user experience consistency, and performance requirements
/speckit.constitution

Create principles focused on code quality,
testing standards, user experience consistency,
and performance requirements.
```

### 3. Create the spec

Use the **`/speckit.specify`** command to describe what you want to build. Focus on the **what** and **why**, not the tech stack.

```bash
/speckit.specify Build an application that can help me organize my photos in separate photo albums. Albums are grouped by date and can be re-organized by dragging and dropping on the main page. Albums are never in other nested albums. Within each album, photos are previewed in a tile-like interface.
/speckit.specify

Build an application that can help me
organize my photos in separate
photo albums.

Albums are grouped by date and can be
re-organized by dragging and dropping
on the main page.

Albums are never in other nested
albums.

Within each album, photos are
previewed in a tile-like interface.
```

### 4. Create a technical implementation plan

Use the **`/speckit.plan`** command to provide your tech stack and architecture choices.

```bash
/speckit.plan The application uses Vite with minimal number of libraries. Use vanilla HTML, CSS, and JavaScript as much as possible. Images are not uploaded anywhere and metadata is stored in a local SQLite database.
/speckit.plan

The application uses Vite with
minimal number of libraries.

Use vanilla HTML, CSS, and
JavaScript as much as possible.

Images are not uploaded anywhere and
metadata is stored in a local
SQLite database.
```

### 5. Break down into tasks
Expand Down