Skip to content

Commit b66f687

Browse files
committed
Update README: remove localcode-afm, add release link, update AGENTS.md reminder
1 parent df521c5 commit b66f687

2 files changed

Lines changed: 8 additions & 6 deletions

File tree

AGENTS.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,14 +98,17 @@ Commit session notes so they can be reviewed later.
9898

9999
**This is a public open source project.** Before every commit:
100100

101-
1. **Update README.md** if you added new features, changed architecture, or modified the workflow
101+
1. **Update README.md** if you added new features, changed architecture, or modified the workflow - keep architecture diagram in sync with actual files
102102
2. **Check examples still work** - commands in README should be tested
103103
3. **Verify docs match code** - if you changed how something works, update the docs
104104
4. **Update Makefile** if you added new commands or scripts
105105
5. **Run `make test`** to ensure prompt tests pass
106+
6. **Update release link** in README if there are breaking changes or significant updates
106107

107108
README is often the first thing new users see. Outdated docs = bad first impression.
108109

110+
**After releases:** Update "[Latest Release](https://github.com/localcodeai/localcode/releases/latest)" link in README if version changed.
111+
109112
## Agent Commands
110113

111114
Use Makefile for common operations:

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,15 @@ LocalCode is a proof-of-concept that integrates Apple Foundation Models (AFM) wi
2424
LocalCode/
2525
├── LocalCode/Sources/afmhelper/ # Swift AFM helper
2626
│ └── main.swift # Apple FoundationModels integration
27-
├── localcode-afm/ # npm package for distribution
28-
│ ├── bin/start.sh # Entry point
29-
│ ├── package.json # Package config
30-
│ └── src/main.swift # Swift source
3127
├── start-afm-server.sh # HTTP middleware (Bun)
3228
├── setup-localcode.sh # One-command setup script
3329
├── pre-commit.sh # Pre-commit hook with tests
34-
└── test-prompts.sh # Prompt test suite
30+
├── test-prompts.sh # Prompt test suite
31+
└── docs/ # VitePress documentation site
3532
```
3633

34+
**[Latest Release](https://github.com/localcodeai/localcode/releases/latest): v0.0.1-alpha**
35+
3736
**No fork needed** - uses global OpenCode with provider config in `~/.config/opencode/opencode.json`
3837

3938
**Flow:**

0 commit comments

Comments
 (0)