Skip to content

Commit b321ed8

Browse files
clarify dev instructions (#35)
1 parent 6c29691 commit b321ed8

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

readme-dev.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
### Quick start from sources
1+
This package lists codex only as a dev dependency and requires the codex binary.
2+
It may not work with versions other than the one specified in package.json.
23

3-
#### Download or install codex binary
4+
### Quick start
45

5-
Last checked version: `codex-cli 0.64.0-alpha.9`)
6-
7-
###### Develop on Windows?
8-
- Download and install [bum](https://bun.com/docs/installation#windows)
6+
#### Develop on Windows?
7+
- Download and install [bun](https://bun.com/docs/installation#windows)
98
- Download and install [C++ redistributable package](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170#latest-supported-redistributable-version)
109

1110
#### Adjust acp config for IDE
@@ -26,7 +25,8 @@ Run from sources
2625
"/path/to/project/"
2726
],
2827
"env": {
29-
"CODEX_PATH": "/path/to/codex"
28+
"CODEX_PATH": "node_modules/.bin/codex",
29+
"APP_SERVER_LOGS": "optional/path/to/existing/log/directory"
3030
}
3131
}
3232
}
@@ -53,11 +53,9 @@ Run from binaries
5353
}
5454
```
5555

56-
Optionally, set a path to log directory via env variable `APP_SERVER_LOGS`.
57-
5856
### Build binaries
5957

60-
Build single executables in `dist/bin` directory:
58+
Build single-file executables in `dist/bin` directory:
6159

6260
```bash
6361
npm run bundle:all
@@ -69,6 +67,8 @@ Package binaries into zip archives:
6967
npm run package:all
7068
```
7169

72-
### Generate codex-specific types
70+
### Update supported Codex version
7371

74-
Generate files in `src/app-server/`: `npm run generate-types`
72+
1. Update Codex dependency: `package.json`
73+
2. Regenerate Codex types in `src/app-server/`: `npm run generate-types`
74+
3. Ensure there are no type errors or failed tests: `npm run typecheck` and `npm run test`

0 commit comments

Comments
 (0)