You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-5Lines changed: 19 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,26 @@
1
1
# SwiftMonocle
2
2
3
-
SwiftMonocle is a macOS Swift package scaffold for a focused library project.
3
+
SwiftMonocle is an early macOS-first Swift package for building scoped, syntax-aware coding context.
4
4
5
5
## Overview
6
6
7
7
### Motivation
8
8
9
-
This repository starts from a clean Swift Package Manager baseline so the core package shape, local repo maintenance scripts, and repo-local Codex plugin wiring are already in place before product work begins.
9
+
The project is exploring a single canonical `CodeScope` model that can merge editor context, syntax-derived symbols, diagnostics, docs, and agent state into one bounded snapshot for local coding workflows.
10
10
11
11
### Current status
12
12
13
-
The package is intentionally minimal right now. The immediate goal is to keep the repository organized, reproducible, and ready for the first real implementation pass.
13
+
SwiftMonocle is very under construction.
14
+
15
+
The package is still in its foundation stage, the public API is not stable, and the repository is currently closer to a live design-and-implementation sandbox than a consumable library release.
16
+
17
+
Recent work has focused on:
18
+
19
+
- defining the first shared scope snapshot model
20
+
- splitting the package into `Core` and `CodeScope` targets
21
+
- wiring in the first `SwiftSyntax`-backed symbol extraction from live editor buffers
22
+
23
+
Expect rapid changes, missing features, rough edges, and frequent restructuring while the real product boundary settles.
14
24
15
25
## Requirements
16
26
@@ -31,6 +41,8 @@ Run the tests:
31
41
swift test
32
42
```
33
43
44
+
This build is still exploratory. Passing builds and tests only mean the current prototype is internally consistent, not that the package is feature-complete or ready for external adoption.
@@ -52,4 +66,4 @@ Because the local Codex app-server install RPC did not return a `plugin/install`
52
66
53
67
## Planning
54
68
55
-
Project planning lives in [`ROADMAP.md`](./ROADMAP.md). Once the product direction is decided, update the roadmap and README together so the repo stays grounded in the same scope.
69
+
Project planning lives in [`ROADMAP.md`](./ROADMAP.md), with additional maintainer design notes in [`docs/maintainers`](./docs/maintainers). Until the first product milestone is fully defined, treat the roadmap and the maintainer docs as the source of truth for what this repository is actually trying to become.
0 commit comments