Skip to content

Commit d53bbe4

Browse files
authored
Merge pull request #13 from ai4curation/claude/issue-12-20250912-2059
docs: enhance just setup-ai instructions with detailed explanation
2 parents a960a3e + 696d459 commit d53bbe4

1 file changed

Lines changed: 17 additions & 2 deletions

File tree

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,23 @@ CBORG_API_KEY
9494

9595
### Setup
9696

97-
After setting up env vars:
97+
After running copier and setting up environment variables, run the following command to complete the AI integration setup:
9898

99-
`just -f ai.just setup-ai`
99+
100+
```bash
101+
just -f ai.just setup-ai
102+
```
103+
104+
This command performs two main setup tasks:
105+
106+
1. **AI Agent Configuration** (`setup-ai-instructions`):
107+
- Creates `CLAUDE.md` symlink to `AGENTS.md` for Claude Code instructions
108+
- Creates `.goosehints` symlink to `AGENTS.md` for Goose agent instructions
109+
- Creates `.github/copilot-instructions.md` symlink to `AGENTS.md` for GitHub Copilot instructions
110+
111+
2. **GitHub Repository Setup** (`setup-gh`):
112+
- Adds repository topics for discoverability (`monarchinitiative,ai4curation`)
113+
- Configures repository secrets from your environment variables (PAT_FOR_PR, ANTHROPIC_API_KEY, etc.)
100114

101115
# FAQ
102116

@@ -110,3 +124,4 @@ Error: Failed to setup GitHub token: Error: Workflow validation failed. The work
110124
If you instead wish to use this action with a custom GitHub token or custom GitHub app, provide a `github_token` in the `uses` section of the app in your workflow yml file.
111125
Error: Process completed with exit code 1.
112126
```
127+

0 commit comments

Comments
 (0)