Update README with project initialization instructions#1772
Open
lubatti wants to merge 1 commit intogithub:mainfrom
Open
Update README with project initialization instructions#1772lubatti wants to merge 1 commit intogithub:mainfrom
lubatti wants to merge 1 commit intogithub:mainfrom
Conversation
Added instructions for creating a new project and initializing in an existing project.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the README “Get Started” instructions to clarify how to initialize Spec Kit via one-time uvx usage for both new projects and existing directories.
Changes:
- Adds an explicit “Create new project” comment to the one-time usage example.
- Adds an explicit “initialize in existing project” one-time usage command (
specify init .viauvx).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME> | ||
|
|
||
| # Or initialize in existing project | ||
| uvx --from git+https://github.com/github/spec-kit.git specify init . |
There was a problem hiding this comment.
In the one-time usage example, you only show initialization via . but elsewhere in the README (and in other docs) you also present the --here variant. Consider adding the uvx ... specify init --here alternative (or a brief note that . and --here are equivalent) to keep the instructions consistent and avoid confusion on shells/OSes where . can be ambiguous.
Suggested change
| uvx --from git+https://github.com/github/spec-kit.git specify init . | |
| uvx --from git+https://github.com/github/spec-kit.git specify init . | |
| # or | |
| uvx --from git+https://github.com/github/spec-kit.git specify init --here |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Specified instructions for One-time Usage for new and existing project.
AI Disclosure