From b558af3a5f8ac6e90c05e6c79d35c4339202bd31 Mon Sep 17 00:00:00 2001 From: hanez Date: Wed, 11 Feb 2026 08:53:18 +0100 Subject: [PATCH] Some more documentation fun. No code changes. (0.38.11) --- docs/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..5e2d09b --- /dev/null +++ b/docs/README.md @@ -0,0 +1,18 @@ +# Fun Documentation Index + +This file serves as an index of the documents in this directory. Links are relative and can be opened directly on Git hosting or locally. + +## Overview + +- [handbook.md](./handbook.md) — Comprehensive handbook for the Fun language and VM: install/build, configuration flags, usage, and full feature overview. +- [types.md](./types.md) — Core types (numbers, strings, arrays, maps, nil/bool), common operations, patterns, and interop notes. +- [includes.md](./includes.md) — Using local vs. system includes, FUN_LIB_DIR, DEFAULT_LIB_DIR, and namespaced includes with `as`. +- [repl.md](./repl.md) — REPL guide: how to build/launch, editing and history, completions, REPL‑on‑error, and tips. +- [opcodes.md](./opcodes.md) — VM opcodes overview grouped by domain with brief behavior/stack notes. +- [internals.md](./internals.md) — Implementation details: bytecode format, VM architecture, stacks/frames, parser, and dispatch. +- [rust.md](./rust.md) — Writing Rust‑backed opcodes and wiring them into the C VM; build/setup notes. + +## Tips + +- When building from the repo without installing, set `FUN_LIB_DIR` to the local `./lib` directory so examples and the REPL can locate the stdlib. +- For a broader project overview and quickstart, see the repository root [README.md](../README.md).