Skip to content

Commit a529305

Browse files
Testclaude
andcommitted
docs: remove outdated OCaml references from README
- Update Quick Start to use cargo/Rust tooling (not dune/OCaml) - Update Development section with actual stack (Rust+Idris2+Zig) - Remove references to OCaml type safety (use Hindley-Milner instead) - Clarify that 76% Rust is normal for language infrastructure The actual implementation uses: - Rust for compiler/VM/interpreter - Idris2 for ABI with formal proofs - Zig for FFI C-compatible layer - WokeLang for examples and (future) stdlib Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 4acb45f commit a529305

1 file changed

Lines changed: 44 additions & 52 deletions

File tree

README.adoc

Lines changed: 44 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ WokeLang: A Human-Centered Programming Language
1717

1818
WokeLang is a programming language designed for **human collaboration**, **empathy**, and **safety**—without sacrificing power or performance. It combines:
1919

20-
- **Pythons readability** with **Rusts performance**.
21-
- **OCaml’s type safety** with **JavaScripts expressiveness**.
20+
- **Python's readability** with **Rust's performance**.
21+
- **Hindley-Milner type inference** with **JavaScript's expressiveness**.
2222
- **Unique features** like `thanks to`, `only if okay`, and `measured in` for **ethical, self-documenting code**.
2323
2424
## Table of Contents
@@ -36,37 +36,41 @@ WokeLang is a programming language designed for **human collaboration**, **empat
3636
```bash
3737
git clone https://github.com/hyperpolymath/wokelang.git
3838
cd wokelang
39-
./scripts/setup.sh
39+
40+
# Install dependencies (asdf + tools)
41+
asdf install # installs rust, deno, idris2, zig
42+
43+
# Build
44+
cargo build --release
4045

4146
2. Run the REPL
4247
43-
dune utop
48+
cargo run --release -- repl
4449

4550
Example REPL Session:
4651

47-
> hello "Welcome to WokeLang!"
48-
> remember x = 5 measured in km
49-
> what is x + 3 measured in km?
50-
8 measured in km
52+
wokelang> remember x = 5 measured in km
53+
wokelang> x + 3 measured in km
54+
Result: 8 measured in km
5155

5256
3. Run Examples
5357
5458
# Hello World
55-
dune exec ./examples/hello_world.wl
59+
cargo run --release -- run examples/01_hello.woke
5660

5761
# Fibonacci
58-
dune exec ./examples/fibonacci.wl
62+
cargo run --release -- run examples/13_fibonacci.woke
5963

60-
# Gratitude Tracker (Blockchain)
61-
dune exec ./examples/gratitude_blockchain.wl
64+
# All examples
65+
ls examples/*.woke
6266
63-
4. Build for Vyper/WASM
67+
4. Build & Execute
6468
65-
# Vyper FFI
66-
cd src/ffi/vyper && vyper contracts/gratitude.vy
69+
# Compile to bytecode
70+
cargo run --release -- compile examples/01_hello.woke -o hello.wbc
6771
68-
# WASM
69-
cd src/ffi/wasm && wasm-pack build --target web
72+
# Run on VM
73+
cargo run --release -- run-vm hello.wbc
7074
7175
```markdown
7276
## 🌟 Key Features
@@ -179,38 +183,26 @@ just fmt # Code formatting
179183

180184
## 🛠 Development
181185

182-
### Dev Container
183-
```dockerfile
184-
FROM ocaml/opam:ubuntu-22.04
185-
186-
# Install OCaml + Rust + Vyper
187-
RUN opam install -y dune merlin ocaml-lsp menhir && \
188-
apt-get update && apt-get install -y python3-pip && \
189-
pip3 install vyper maturin && \
190-
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y && \
191-
source "$HOME/.cargo/env" && \
192-
rustup target add wasm32-unknown-unknown && \
193-
cargo install wasm-pack
194-
195-
WORKDIR /workspace
196-
COPY . .
197-
RUN dune build
198-
199-
🛠️ Development
200-
201-
Dev Container
202-
203-
FROM ocaml/opam:ubuntu-22.04
204-
205-
# Install OCaml + Rust + Vyper
206-
RUN opam install -y dune merlin ocaml-lsp menhir && \
207-
apt-get update && apt-get install -y python3-pip && \
208-
pip3 install vyper maturin && \
209-
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y && \
210-
source "$HOME/.cargo/env" && \
211-
rustup target add wasm32-unknown-unknown && \
212-
cargo install wasm-pack
213-
214-
WORKDIR /workspace
215-
COPY . .
216-
RUN dune build
186+
### Development Environment
187+
188+
**Required Tools** (managed via asdf):
189+
- Rust 1.84.0 - Compiler infrastructure
190+
- Deno 2.1.4 - Runtime (NO Node.js/npm)
191+
- Idris2 0.7.0 - ABI with formal proofs
192+
- Zig 0.13.0 - FFI C-compatible implementation
193+
194+
```bash
195+
# Install asdf
196+
git clone https://github.com/asdf-vm/asdf.git ~/.asdf
197+
198+
# Install plugins
199+
asdf plugin add rust
200+
asdf plugin add deno
201+
asdf plugin add idris2
202+
asdf plugin add zig
203+
204+
# Install versions (from .tool-versions)
205+
asdf install
206+
207+
# Build
208+
cargo build --release

0 commit comments

Comments
 (0)