From 6ee78cc4fb0d770e9a674664a96568a6f7bf69dd Mon Sep 17 00:00:00 2001 From: hanez Date: Wed, 11 Feb 2026 17:55:04 +0100 Subject: [PATCH] Some more documentation fun. No code changes. (0.38.11) --- docs/examples.md | 6 +++--- docs/testing.md | 6 +++--- docs/troubleshooting.md | 10 +++++----- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/examples.md b/docs/examples.md index ab18e0e..358ef0f 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -6,20 +6,20 @@ All commands assume you are in the repository root. ## Prerequisites -- Build the interpreter (see handbook.md). You’ll have `build_debug/fun` or `build_release/fun` (paths may vary by your setup/IDE). +- Build the interpreter (see handbook.md). You’ll have `build/fun` (paths may vary by your setup/IDE). - Set FUN_LIB_DIR to the repo’s lib directory when running without installation so `#include <...>` can find the standard library. Example (Linux/macOS/BSD): ``` -FUN_LIB_DIR="$(pwd)/lib" ./build_debug/fun examples/include_lib.fun +FUN_LIB_DIR="$(pwd)/lib" ./build/fun examples/include_lib.fun ``` Windows (PowerShell): ``` $env:FUN_LIB_DIR = "$PWD/lib" -./build_release/fun.exe .\examples\include_lib.fun +./build/fun.exe .\examples\include_lib.fun ``` ## Interactive showcase: play.fun diff --git a/docs/testing.md b/docs/testing.md index 6176b70..410e18a 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -18,19 +18,19 @@ To list targets with CMake directly, consult your IDE or run the build system’ Debug profile example: ``` -cmake --build build_debug --target test_opcodes && ./build_debug/test_opcodes +cmake --build build_debug --target test_opcodes && ./build/test_opcodes ``` Release profile example: ``` -cmake --build build_release --target test_opcodes && ./build_release/test_opcodes +cmake --build build_release --target test_opcodes && ./build/test_opcodes ``> If `fun_test` exists in your configuration: ``` -cmake --build build_debug --target fun_test && ./build_debug/fun_test +cmake --build build_debug --target fun_test && ./build/fun_test ``` You can also invoke CTest to run any tests registered with `add_test()`: diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 9835e04..e8dfec0 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -17,14 +17,14 @@ Linux/macOS/BSD: ``` export FUN_LIB_DIR="$(pwd)/lib" -./build_debug/fun examples/include_lib.fun +./build/fun examples/include_lib.fun ``` Windows (PowerShell): ``` $env:FUN_LIB_DIR = "$PWD/lib" -./build_release/fun.exe .\examples\include_lib.fun +./build/fun.exe .\examples\include_lib.fun ``` If `FUN_LIB_DIR` is not set, the interpreter tries a compile‑time `DEFAULT_LIB_DIR`, and finally falls back to `./lib` relative to the current working directory. Be mindful of where you run the `fun` binary from. @@ -42,7 +42,7 @@ Fix: ``` cmake -S . -B build_debug -DFUN_WITH_REPL=ON cmake --build build_debug --target fun -FUN_LIB_DIR="$(pwd)/lib" ./build_debug/fun +FUN_LIB_DIR="$(pwd)/lib" ./build/fun ``` See repl.md for usage tips and features. @@ -81,11 +81,11 @@ Symptoms: - Setting environment variables has no effect; include paths remain unresolved. Fix: -- In CMD use: `set FUN_LIB_DIR=%CD%\lib && build-debug\fun.exe examples\include_lib.fun` +- In CMD use: `set FUN_LIB_DIR=%CD%\lib && build\fun.exe examples\include_lib.fun` - In PowerShell use: `$env:FUN_LIB_DIR = "$PWD\lib"; .\build\fun.exe .\examples\include_lib.fun` ## Getting help - Run the interpreter with `--help` to see supported flags. - Explore docs/handbook.md and docs/repl.md. -- Check the examples under `examples/` and try `./play.fun` for an interactive tour. +- Check the examples under `examples/` for an interactive tour.