Skip to content

Commit 656537d

Browse files
committed
Document WASM tooling requirements and fix metadata for new crates
1 parent c421414 commit 656537d

File tree

6 files changed

+70
-1
lines changed

6 files changed

+70
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
> **THE PROOF IS MATHEMATICAL.**
1313
> **TIME WILL TELL.**
1414
>
15-
> 🔗 [AIΩN Organization](https://github.com/your-org) | [JITOS RFCs](https://jitos.dev/rfcs) | [CΩMPUTER Paper](link)
15+
> 🔗 [AIΩN](https://github.com/flyingrobots/aion) | [JITOS RFCs](https://github.com/flyingrobots/jitos) | [CΩMPUTER Paper](https://github.com/flyingrobots/aion-computer-book)
1616
1717
```rust
1818
//! ░▒▓████████▓▒░▒▓██████▓▒░░▒▓█▓▒░░▒▓█▓▒░░▒▓██████▓▒░
@@ -72,6 +72,11 @@ Echo doesn’t “update objects.” It _rewrites_ parts of the graph using a se
7272

7373
Echo follows the JITOS Engineering Standard: every SPEC is simultaneously documentation, implementation, interactive demo (WASM), living test, and contributor certification. See `docs/METHODOLOGY.md` for the full 5x Duty model and workflow.
7474

75+
### WASM Dev Quickstart (Spec-000)
76+
- Prereq: `rustup target add wasm32-unknown-unknown` and `cargo install --locked trunk`
77+
- Dev: `make spec-000-dev` (hot reload at http://127.0.0.1:8080)
78+
- Build: `make spec-000-build` (outputs to `specs/spec-000-rewrite/dist/`)
79+
7580
### Why Echo's Cool
7681

7782
- **Deterministic:** same inputs = same world every time.

crates/echo-session-ws-gateway/Cargo.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
name = "echo-session-ws-gateway"
55
version = "0.1.0"
66
edition = "2021"
7+
description = "WebSocket to Unix-socket bridge for the Echo session hub (browser clients -> JS-ABI frames)"
8+
license = "Apache-2.0"
9+
repository = "https://github.com/flyingrobots/echo"
10+
readme = "README.md"
11+
keywords = ["echo", "rmg", "websocket", "gateway", "wasm"]
12+
categories = ["network-programming", "web-programming", "asynchronous"]
713

814
[dependencies]
915
anyhow = "1"
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- SPDX-License-Identifier: Apache-2.0 OR MIND-UCAL-1.0 -->
2+
<!-- © James Ross Ω FLYING•ROBOTS <https://github.com/flyingrobots> -->
3+
# echo-session-ws-gateway
4+
5+
WebSocket ↔ Unix-socket bridge for the Echo session hub. It terminates browser WebSocket connections, enforces JS-ABI frame sizing, and forwards binary frames to the Unix-domain socket exposed by `echo-session-service`.
6+
7+
## Usage
8+
9+
```
10+
cargo run -p echo-session-ws-gateway -- \
11+
--unix-socket /tmp/echo-session.sock \
12+
--listen 0.0.0.0:8787 \
13+
--allow-origin https://your.host \
14+
--tls-cert cert.pem --tls-key key.pem
15+
```
16+
17+
## Features
18+
- Binary WS frames → JS-ABI packets over UDS
19+
- Payload guard (8 MiB default)
20+
- Optional origin allowlist
21+
- Optional TLS (rustls)
22+
- Ping/pong keepalive

specs/spec-000-rewrite/Cargo.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
name = "spec-000-rewrite"
55
version = "0.1.0"
66
edition = "2024"
7+
description = "Living spec (Spec-000) for Echo/JITOS: Leptos + Trunk WASM demo scaffold"
8+
license = "Apache-2.0"
9+
repository = "https://github.com/flyingrobots/echo"
10+
readme = "README.md"
11+
keywords = ["echo", "rmg", "wasm", "leptos", "spec"]
12+
categories = ["wasm", "gui", "education"]
713

814
[lib]
915
crate-type = ["cdylib", "rlib"]

specs/spec-000-rewrite/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!-- SPDX-License-Identifier: Apache-2.0 OR MIND-UCAL-1.0 -->
2+
<!-- © James Ross Ω FLYING•ROBOTS <https://github.com/flyingrobots> -->
3+
# Spec-000 Rewrite (Living Spec)
4+
5+
Leptos + Trunk WASM scaffold for Spec-000: “Everything Is a Rewrite.” This page will embed the actual Echo/JITOS kernel in the browser to demonstrate rewrite-driven state.
6+
7+
## Dev
8+
9+
```
10+
rustup target add wasm32-unknown-unknown
11+
cargo install --locked trunk
12+
make spec-000-dev # from repo root
13+
```
14+
15+
Serves at http://127.0.0.1:8080 with hot reload.
16+
17+
## Build
18+
19+
```
20+
make spec-000-build # outputs dist/
21+
```
22+
23+
## Next steps
24+
- Wire kernel bindings (wasm-bindgen feature)
25+
- Render RMG graph + rewrite log
26+
- Add completion badge win condition

specs/spec-000-rewrite/src/lib.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
use leptos::*;
66
use wasm_bindgen::prelude::*;
77

8+
/// Top-level Spec-000 Leptos component (WASM).
9+
#[allow(missing_docs)]
810
#[component]
911
pub fn App() -> impl IntoView {
1012
let (epoch, set_epoch) = create_signal(0usize);
@@ -34,6 +36,8 @@ pub fn App() -> impl IntoView {
3436
}
3537
}
3638

39+
/// WASM entry point required by `trunk serve`.
40+
#[allow(missing_docs)]
3741
#[wasm_bindgen(start)]
3842
pub fn main() {
3943
console_error_panic_hook::set_once();

0 commit comments

Comments
 (0)