Skip to content

Commit b7161b6

Browse files
raj-jain-awsleandrodamascena
raj-jain-aws
and
leandrodamascena
authored
fix: Minor updates to README (#192)
* Moved experimental installation lower * Update CONTRIBUTING.md Co-authored-by: Leandro Damascena <lcdama@amazon.pt> * Update README.md Fixed header syntax --------- Co-authored-by: Leandro Damascena <lcdama@amazon.pt>
1 parent 63a221a commit b7161b6

2 files changed

Lines changed: 60 additions & 56 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ Rules are organized by phase:
4646

4747
Test your rule changes with at least one supported platform (Amazon Q Developer, Kiro, or other tools) before submitting. Describe what you tested in your PR.
4848

49+
If you're adding or updating installation instructions, ensure you've tested them on Mac,
50+
Windows CMD, and Windows Powershell.
51+
4952
## Reporting Bugs/Feature Requests
5053

5154
Use GitHub issues to report bugs or suggest features. Before filing, check existing issues to avoid duplicates.

‎README.md‎

Lines changed: 57 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ AI-DLC is an intelligent software development workflow that adapts to your needs
99
## Table of Contents
1010

1111
- [Common](#common)
12-
- [Experimental: AI-Assisted Setup (Release Download)](#experimental-ai-assisted-setup-release-download)
1312
- [Platform-Specific Setup](#platform-specific-setup)
1413
- [Usage](#usage)
1514
- [Three-Phase Adaptive Workflow](#three-phase-adaptive-workflow)
@@ -20,7 +19,9 @@ AI-DLC is an intelligent software development workflow that adapts to your needs
2019
- [Troubleshooting](#troubleshooting)
2120
- [Version Control Recommendations](#version-control-recommendations)
2221
- [Additional Resources](#additional-resources)
23-
- [Security](#security)
22+
- [Generated aidlc-docs/ Reference](#generated-aidlc-docs-reference)
23+
- [Experimental: AI-Assisted Setup (Release Download)](#experimental-ai-assisted-setup-release-download)
24+
- [Contributing](#contributing)
2425
- [License](#license)
2526

2627
---
@@ -35,59 +36,6 @@ AI-DLC is an intelligent software development workflow that adapts to your needs
3536

3637
---
3738

38-
### Experimental: AI-Assisted Setup (Release Download)
39-
40-
> Instead of manually copying files, let your AI agent handle the setup. This is an experimental workflow — currently validated with Kiro, Claude code, Cursor, Antigravity.
41-
>
42-
> **Note:** This approach requires your agent to have shell access (e.g., Kiro, Claude Code, Cline). For agents without shell access, follow the [Common](#common) setup above.
43-
44-
Paste this prompt into your AI agent:
45-
46-
```text
47-
Set up AI-DLC in this project by doing the following:
48-
49-
1. Download the latest AI-DLC release:
50-
- Use the GitHub API to find the latest release asset URL:
51-
curl -sL https://api.github.com/repos/awslabs/aidlc-workflows/releases/latest \
52-
| grep -o '"browser_download_url": *"[^"]*"' \
53-
| head -1 \
54-
| cut -d'"' -f4
55-
- Download the zip from that URL to /tmp/aidlc-rules.zip
56-
- Extract it: unzip -o /tmp/aidlc-rules.zip -d /tmp/aidlc-release
57-
- Copy the aidlc-rules/ folder from the extracted contents into .aidlc at the project root
58-
- Clean up: rm -rf /tmp/aidlc-rules.zip /tmp/aidlc-release
59-
60-
2. Create the appropriate rules/steering file for your IDE using the options below.
61-
Pick the one that matches the agent you are running in:
62-
63-
- Kiro IDE or Kiro CLI → create `.kiro/steering/ai-dlc.md`
64-
- Amazon Q Developer → create `.amazonq/rules/ai-dlc.md`
65-
- Antigravity → create `.agent/rules/ai-dlc.md`
66-
- Cursor → create `.cursor/rules/ai-dlc.mdc` with frontmatter:
67-
---
68-
description: "AI-DLC workflow"
69-
alwaysApply: true
70-
---
71-
- Cline → create `.clinerules/ai-dlc.md`
72-
- Claude Code → create `CLAUDE.md`
73-
- GitHub Copilot → create `.github/copilot-instructions.md`
74-
- Any other agent → create `AGENTS.md`
75-
76-
3. The file content should be:
77-
When the user invokes AI-DLC, read and follow
78-
`.aidlc/aidlc-rules/aws-aidlc-rules/core-workflow.md` to start the workflow.
79-
80-
4. Add `.aidlc` to `.gitignore` unless I explicitly ask you not to.
81-
82-
5. Confirm what file you created and that `.aidlc` is gitignored.
83-
```
84-
85-
The agent will download the latest release, create the correct config file for your IDE, and gitignore the `.aidlc` directory automatically.
86-
87-
**Updating AI-DLC** — Re-run the prompt above. The agent will download the latest release and overwrite the existing `.aidlc/` folder.
88-
89-
---
90-
9139
## Platform-Specific Setup
9240

9341
- [Kiro](#kiro)
@@ -784,6 +732,59 @@ For the complete reference of all documentation artifacts generated by the AI-DL
784732

785733
---
786734

735+
## Experimental: AI-Assisted Setup (Release Download)
736+
737+
> Instead of manually copying files, let your AI agent handle the setup. This is an experimental workflow — currently validated with Kiro, Claude code, Cursor, Antigravity.
738+
>
739+
> **Note:** This approach requires your agent to have shell access (e.g., Kiro, Claude Code, Cline). For agents without shell access, follow the [Common](#common) setup above.
740+
741+
Paste this prompt into your AI agent:
742+
743+
```text
744+
Set up AI-DLC in this project by doing the following:
745+
746+
1. Download the latest AI-DLC release:
747+
- Use the GitHub API to find the latest release asset URL:
748+
curl -sL https://api.github.com/repos/awslabs/aidlc-workflows/releases/latest \
749+
| grep -o '"browser_download_url": *"[^"]*"' \
750+
| head -1 \
751+
| cut -d'"' -f4
752+
- Download the zip from that URL to /tmp/aidlc-rules.zip
753+
- Extract it: unzip -o /tmp/aidlc-rules.zip -d /tmp/aidlc-release
754+
- Copy the aidlc-rules/ folder from the extracted contents into .aidlc at the project root
755+
- Clean up: rm -rf /tmp/aidlc-rules.zip /tmp/aidlc-release
756+
757+
2. Create the appropriate rules/steering file for your IDE using the options below.
758+
Pick the one that matches the agent you are running in:
759+
760+
- Kiro IDE or Kiro CLI → create `.kiro/steering/ai-dlc.md`
761+
- Amazon Q Developer → create `.amazonq/rules/ai-dlc.md`
762+
- Antigravity → create `.agent/rules/ai-dlc.md`
763+
- Cursor → create `.cursor/rules/ai-dlc.mdc` with frontmatter:
764+
---
765+
description: "AI-DLC workflow"
766+
alwaysApply: true
767+
---
768+
- Cline → create `.clinerules/ai-dlc.md`
769+
- Claude Code → create `CLAUDE.md`
770+
- GitHub Copilot → create `.github/copilot-instructions.md`
771+
- Any other agent → create `AGENTS.md`
772+
773+
3. The file content should be:
774+
When the user invokes AI-DLC, read and follow
775+
`.aidlc/aidlc-rules/aws-aidlc-rules/core-workflow.md` to start the workflow.
776+
777+
4. Add `.aidlc` to `.gitignore` unless I explicitly ask you not to.
778+
779+
5. Confirm what file you created and that `.aidlc` is gitignored.
780+
```
781+
782+
The agent will download the latest release, create the correct config file for your IDE, and gitignore the `.aidlc` directory automatically.
783+
784+
**Updating AI-DLC** — Re-run the prompt above. The agent will download the latest release and overwrite the existing `.aidlc/` folder.
785+
786+
---
787+
787788
## Additional Resources
788789

789790
<!-- TODO: Replace this Amplify URL with a permanent/stable URL when available -->
@@ -804,7 +805,7 @@ For the complete reference of all documentation artifacts generated by the AI-DL
804805

805806
---
806807

807-
## Security
808+
## Contributing
808809

809810
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
810811

0 commit comments

Comments
 (0)