hanez/fun
1
0
Fork 0
forked from fun/fun
Code Pull requests Activity

Some unicode fixes in docs/. No code changes. (0.38.16)

Browse source
This commit is contained in:
Johannes Findeisen 2026-02-19 23:41:34 +01:00
commit b7538ca165
4 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/build.md
View file

@ -23,7 +23,7 @@ Fun exposes several options you can toggle at configure time:
- `FUN_WITH_CPP` (ON/OFF) - Enable C++-based opcode/examples support - `FUN_WITH_CPP` (ON/OFF) - Enable C++-based opcode/examples support
- `FUN_WITH_RUST` (ON/OFF) - Build and link Rust staticlib from `src/rust/` - `FUN_WITH_RUST` (ON/OFF) - Build and link Rust staticlib from `src/rust/`
- `FUN_WITH_OPENSSL` (ON/OFF) - Enable OpenSSL-backed helpers (MD5/SHA-256/SHA-512/RIPEMD-160) - `FUN_WITH_OPENSSL` (ON/OFF) - Enable OpenSSL-backed helpers (MD5/SHA-256/SHA-512/RIPEMD-160)
- `FUN_WITH_LIBRESSL` (ON/OFF) - Enable LibreSSL-backed helpers (MD5/SHA-256/SHA-512/RIPEMD-160) - `FUN_WITH_LIBRESSL` (ON/OFF) - Enable LibreSSL-backed helpers (MD5/SHA-256/SHA-512/RIPEMD-160)
When configuring, the build prints a summary like: When configuring, the build prints a summary like:
@ -62,7 +62,9 @@ cmake --build build_release --target build
If `FUN_WITH_RUST` is enabled, ensure `cargo` is available in PATH; the build will invoke it and link the produced static library. If `FUN_WITH_RUST` is enabled, ensure `cargo` is available in PATH; the build will invoke it and link the produced static library.
If `FUN_WITH_OPENSSL` is enabled, CMake must detect your system OpenSSL (libcrypto). If `FUN_WITH_LIBRESSL` is enabled, CMake detects LibreSSL directly (via pkg-config or standard include/lib locations) and links to LibreSSL’s `libcrypto` — no OpenSSL installation is required. Both extensions use the EVP interface. Note: On OpenSSL 3.x, RIPEMD-160 may require the legacy provider; if unavailable, the helper returns an empty string. If `FUN_WITH_OPENSSL` is enabled, CMake must detect your system OpenSSL (libcrypto).
If `FUN_WITH_LIBRESSL` is enabled, CMake detects LibreSSL directly (via pkg-config or standard include/lib locations) and links to LibreSSL's `libcrypto` — no OpenSSL installation is required. Both extensions use the EVP interface. Note: On OpenSSL 3.x, RIPEMD-160 may require the legacy provider; if unavailable, the helper returns an empty string.
## Running ## Running
- CLI: run the `fun` executable from your build directory. - CLI: run the `fun` executable from your build directory.

2
docs/external/README.md vendored
View file

@ -1,6 +1,6 @@
# External integrations (optional extensions) # External integrations (optional extensions)
This section documents Fun’s optional, build‑time selectable extensions. Each page covers: This section documents Fun's optional, build-time selectable extensions. Each page covers:
- How to enable the extension via CMake option (FUN_WITH_*) - How to enable the extension via CMake option (FUN_WITH_*)
- Build requirements and detection notes - Build requirements and detection notes
- Available opcodes and/or helper functions - Available opcodes and/or helper functions

2
docs/external/libressl.md vendored
View file

@ -1,7 +1,7 @@
# LibreSSL extension (optional) # LibreSSL extension (optional)
- CMake option: FUN_WITH_LIBRESSL=ON - CMake option: FUN_WITH_LIBRESSL=ON
- Purpose: provide small crypto helpers backed by LibreSSL’s libcrypto. Includes md5, sha256, sha512, ripemd160 helpers under libressl_* names. - Purpose: provide small crypto helpers backed by LibreSSL's libcrypto. Includes md5, sha256, sha512, ripemd160 helpers under libressl_* names.
- Homepage: https://www.libressl.org/ - Homepage: https://www.libressl.org/
## Build notes: ## Build notes:

2
docs/external/openssl.md vendored
View file

@ -40,4 +40,4 @@
## Notes: ## Notes:
- The OpenSSL 3.x provider configuration on your system determines availability of RIPEMD‑160. If the legacy provider is not enabled, openssl_ripemd160() will return an empty string. - The OpenSSL 3.x provider configuration on your system determines availability of RIPEMD-160. If the legacy provider is not enabled, openssl_ripemd160() will return an empty string.