Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e566e90708 | ||
|
|
a3b6e4455a | ||
|
|
3259b845ed | ||
|
|
9d01e9d7b6 | ||
|
|
e786a9df64 | ||
|
|
51b8459122 |
22
README.md
22
README.md
@@ -21,8 +21,12 @@
|
|||||||
- [🎯 Experimental goals](#-experimental-goals)
|
- [🎯 Experimental goals](#-experimental-goals)
|
||||||
- [🔧 Prerequisites](#-prerequisites)
|
- [🔧 Prerequisites](#-prerequisites)
|
||||||
- [📖 Learn more](#-learn-more)
|
- [📖 Learn more](#-learn-more)
|
||||||
- [Detailed process](#detailed-process)
|
- [📋 Detailed process](#-detailed-process)
|
||||||
- [Troubleshooting](#troubleshooting)
|
- [🔍 Troubleshooting](#-troubleshooting)
|
||||||
|
- [👥 Maintainers](#-maintainers)
|
||||||
|
- [💬 Support](#-support)
|
||||||
|
- [🙏 Acknowledgements](#-acknowledgements)
|
||||||
|
- [📄 License](#-license)
|
||||||
|
|
||||||
## 🤔 What is Spec-Driven Development?
|
## 🤔 What is Spec-Driven Development?
|
||||||
|
|
||||||
@@ -43,7 +47,7 @@ uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME
|
|||||||
Use the `/specify` command to describe what you want to build. Focus on the **what** and **why**, not the tech stack.
|
Use the `/specify` command to describe what you want to build. Focus on the **what** and **why**, not the tech stack.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
/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 never other nested albums. Within each album, photos are previewed in a tile-like interface.
|
/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.
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3. Create a technical implementation plan
|
### 3. Create a technical implementation plan
|
||||||
@@ -118,7 +122,7 @@ Our research and experimentation focus on:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Detailed process
|
## 📋 Detailed process
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>Click to expand the detailed step-by-step walkthrough</summary>
|
<summary>Click to expand the detailed step-by-step walkthrough</summary>
|
||||||
@@ -341,7 +345,7 @@ Once the implementation step is done, ask Claude Code to try to run the applicat
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Troubleshooting
|
## 🔍 Troubleshooting
|
||||||
|
|
||||||
### Git Credential Manager on Linux
|
### Git Credential Manager on Linux
|
||||||
|
|
||||||
@@ -360,19 +364,19 @@ echo "Cleaning up..."
|
|||||||
rm gcm-linux_amd64.2.6.1.deb
|
rm gcm-linux_amd64.2.6.1.deb
|
||||||
```
|
```
|
||||||
|
|
||||||
## Maintainers
|
## 👥 Maintainers
|
||||||
|
|
||||||
- Den Delimarsky ([@localden](https://github.com/localden))
|
- Den Delimarsky ([@localden](https://github.com/localden))
|
||||||
- John Lam ([@jflam](https://github.com/jflam))
|
- John Lam ([@jflam](https://github.com/jflam))
|
||||||
|
|
||||||
## Support
|
## 💬 Support
|
||||||
|
|
||||||
For support, please open a [GitHub issue](https://github.com/github/spec-kit/issues/new). We welcome bug reports, feature requests, and questions about using Spec-Driven Development.
|
For support, please open a [GitHub issue](https://github.com/github/spec-kit/issues/new). We welcome bug reports, feature requests, and questions about using Spec-Driven Development.
|
||||||
|
|
||||||
## Acknowledgements
|
## 🙏 Acknowledgements
|
||||||
|
|
||||||
This project is heavily influenced by and based on the work and research of [John Lam](https://github.com/jflam).
|
This project is heavily influenced by and based on the work and research of [John Lam](https://github.com/jflam).
|
||||||
|
|
||||||
## License
|
## 📄 License
|
||||||
|
|
||||||
This project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](./LICENSE) file for the full terms.
|
This project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](./LICENSE) file for the full terms.
|
||||||
|
|||||||
@@ -13,10 +13,10 @@ Given the context provided as an argument, do this:
|
|||||||
2. Load and analyze available design documents:
|
2. Load and analyze available design documents:
|
||||||
- Always read plan.md for tech stack and libraries
|
- Always read plan.md for tech stack and libraries
|
||||||
- IF EXISTS: Read data-model.md for entities
|
- IF EXISTS: Read data-model.md for entities
|
||||||
- IF EXISTS: Read contracts/ for API endpoints
|
- IF EXISTS: Read contracts/ for API endpoints
|
||||||
- IF EXISTS: Read research.md for technical decisions
|
- IF EXISTS: Read research.md for technical decisions
|
||||||
- IF EXISTS: Read quickstart.md for test scenarios
|
- IF EXISTS: Read quickstart.md for test scenarios
|
||||||
|
|
||||||
Note: Not all projects have all documents. For example:
|
Note: Not all projects have all documents. For example:
|
||||||
- CLI tools might not have contracts/
|
- CLI tools might not have contracts/
|
||||||
- Simple libraries might not need data-model.md
|
- Simple libraries might not need data-model.md
|
||||||
|
|||||||
Reference in New Issue
Block a user