diff --git a/base/Home.md b/base/Home.md index 4d1d65f..d633f95 100644 --- a/base/Home.md +++ b/base/Home.md @@ -10,7 +10,7 @@ The `base` package provides core data structures and memory abstractions: dynami --- -## Allocator Interface +## ๐Ÿ—„๏ธ Allocator Interface A pluggable allocator that abstracts memory allocation strategies. See os package for the arena-backed implementation. @@ -39,7 +39,7 @@ struct Allocator { --- -## Memory Utilities +## ๐Ÿ”ง Memory Utilities | Function | Description | |----------|-------------| @@ -47,7 +47,7 @@ struct Allocator { --- -## Array +## ๐Ÿ“‹ Array A type-generic dynamic array with both stack-allocated and allocator-backed variants. @@ -119,7 +119,7 @@ wapp_array_append_alloc(i32, &arena, &dyn, &val, ARRAY_INIT_NONE); --- -## Doubly-Linked List +## ๐Ÿ”— Doubly-Linked List A type-generic doubly-linked list with node-level operations. @@ -171,7 +171,7 @@ Str8 *item = wapp_dbl_list_get(Str8, &list, 0); --- -## Queue +## ๐Ÿ“จ Queue A type-generic circular queue (FIFO) backed by a dynamic array. @@ -207,7 +207,7 @@ i32 *result = wapp_queue_pop(i32, &queue); --- -## Str8 +## ๐Ÿ“ Str8 A length-tracked mutable string type. diff --git a/common/Home.md b/common/Home.md index ae5f824..3d459da 100644 --- a/common/Home.md +++ b/common/Home.md @@ -10,7 +10,7 @@ The `common` package provides foundational type definitions, platform detection, --- -## Type Aliases +## ๐Ÿท๏ธ Type Aliases Convenient typedefs for primitive types. @@ -63,7 +63,7 @@ END_C_LINKAGE // } (C++ only) --- -## Platform Detection +## ๐Ÿ’ป Platform Detection The library auto-detects the target platform and language version at compile time. @@ -100,7 +100,7 @@ The library auto-detects the target platform and language version at compile tim --- -## Assertions +## ๐Ÿ›ก๏ธ Assertions Runtime and compile-time assertion macros with configurable behaviour. @@ -135,7 +135,7 @@ Diagnostic: config should not be NULL --- -## Misc Utilities +## ๐Ÿ”ง Misc Utilities Helper macros for size literals, alignment, and bit operations. diff --git a/os/Home.md b/os/Home.md index fb16c10..94abc69 100644 --- a/os/Home.md +++ b/os/Home.md @@ -10,7 +10,7 @@ The `os` package provides OS-level abstractions: virtual memory, arena allocator --- -## OS Memory +## ๐Ÿง  OS Memory Low-level virtual memory allocation. @@ -41,7 +41,7 @@ The commit flag behaviour varies by platform: --- -## Arena Allocator +## ๐Ÿ—„๏ธ Arena Allocator A bump allocator backed by OS virtual memory (or a user-provided buffer). Provides fast sequential allocations with temporary scope support. @@ -117,7 +117,7 @@ wapp_mem_arena_allocator_destroy(&allocator); --- -## File I/O +## ๐Ÿ“ File I/O Cross-platform file operations with array-level read/write support. @@ -193,7 +193,7 @@ wapp_file_remove(&filename); --- -## Shell Commander +## โŒจ๏ธ Shell Commander Execute shell commands and capture or discard their output. @@ -247,7 +247,7 @@ r = wapp_shell_commander_execute(SHELL_OUTPUT_CAPTURE, &buf, &cmd); --- -## Terminal Colours +## ๐ŸŽจ Terminal Colours Print coloured text to the terminal. @@ -264,7 +264,7 @@ Available colours: `WAPP_TERM_COLOUR_FG_BLACK`, `WAPP_TERM_COLOUR_FG_RED`, `WAPP --- -## CPath +## ๐Ÿ“ CPath Cross-platform path manipulation. @@ -310,7 +310,7 @@ Str8 *grandparent = wapp_cpath_dirup(&arena, &dir, 2); // "/home" --- -## Shell Utils +## ๐Ÿ”ง Shell Utils Cross-platform wrappers for `popen`/`pclose`. diff --git a/prng/Home.md b/prng/Home.md index c25a4cd..633f36f 100644 --- a/prng/Home.md +++ b/prng/Home.md @@ -10,7 +10,7 @@ The `prng` package provides a **Xorshift256** pseudo-random number generator. It --- -## Xorshift256 +## ๐ŸŽฒ Xorshift256 A fast, non-cryptographic PRNG with a 256-bit state. Three variants are available with different trade-offs between speed and statistical quality. diff --git a/testing/Home.md b/testing/Home.md index 18d4f17..c0e5b89 100644 --- a/testing/Home.md +++ b/testing/Home.md @@ -10,7 +10,7 @@ The `testing` package provides a lightweight test runner with coloured pass/fail --- -## Tester +## ๐Ÿงช Tester Each test is a function that returns a `TestFuncResult`. Tests are registered by passing their function pointers to `wapp_tester_run_tests`. diff --git a/uuid/Home.md b/uuid/Home.md index 7c73a5a..cea90ef 100644 --- a/uuid/Home.md +++ b/uuid/Home.md @@ -10,7 +10,7 @@ The `uuid` package provides **UUID v4** generation as specified by RFC 4122. UUI --- -## UUID v4 +## ๐Ÿ†” UUID v4 ### Type