Skip to content

Commit 484d40a

Browse files
committed
remove note about private repository
1 parent d358680 commit 484d40a

File tree

1 file changed

+21
-27
lines changed

1 file changed

+21
-27
lines changed

README.md

Lines changed: 21 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,27 @@ export RUST_LOG=trace
107107
./target/debug/kcserver
108108
```
109109

110+
## Repository Structure
111+
112+
```
113+
.
114+
+-- kallichore.json -- OpenAPI description of the Kallichore API
115+
|
116+
+-- crates
117+
|
118+
+-- kallichore_api -- Code-generated Rust client/server
119+
| |
120+
| +-- examples/client -- Example client
121+
| |
122+
| +-- examples/server -- Example server
123+
|
124+
+-- kcshared -- Shared code for the server and client
125+
|
126+
+-- kcserver -- Main Kallichore server, using the kallichore_api crate
127+
|
128+
+-- kcclient -- Command-line client (for testing), using the kallichore_api crate
129+
```
130+
110131
## API Changes
111132

112133
To make changes to the API, edit the `kallichore.json` file and then run the `scripts/regen-api.sh` script to regenerate the Rust client and server crates.
@@ -236,38 +257,11 @@ The server automatically selects the appropriate transport based on:
236257
- **Named Pipes**: Use Windows security descriptors for access control
237258
- **Authentication**: All transports support bearer token authentication when enabled
238259

239-
## Repository Structure
240-
241-
```
242-
.
243-
+-- kallichore.json -- OpenAPI description of the Kallichore API
244-
|
245-
+-- crates
246-
|
247-
+-- kallichore_api -- Code-generated Rust client/server
248-
| |
249-
| +-- examples/client -- Example client
250-
| |
251-
| +-- examples/server -- Example server
252-
|
253-
+-- kcshared -- Shared code for the server and client
254-
|
255-
+-- kcserver -- Main Kallichore server, using the kallichore_api crate
256-
|
257-
+-- kcclient -- Command-line client (for testing), using the kallichore_api crate
258-
```
259-
260260

261261
## Builds and Versions
262262

263263
Kallichore is versioned similar to ARK. No release builds are produced by default. When you want to release a new version of Kallichore (for integrating into Positron, etc.), bump the version of the `kcserver` crate. This will trigger a release build.
264264

265-
Note that because this repository is private, and Positron is public, there's a public repository that hosts Kallichore builds for Positron to download while building. You can find that here:
266-
267-
<https://github.com/posit-dev/kallichore-builds>
268-
269-
All Kallichore releases are automatically copied to the `kallichore-builds` repository.
270-
271265
## Adjacent Projects/Links
272266

273267
[Jupyter Kernel Gateway](https://jupyter-kernel-gateway.readthedocs.io/en/latest/): a headless Jupyter server that uses WebSockets to deliver Jupyter messages.

0 commit comments

Comments
 (0)