Mercurial
diff dowa/README.md @ 192:b818a4561a3c hg-web
Added AI genreated README.md. Needed to be read.
| author | MrJuneJune <me@mrjunejune.com> |
|---|---|
| date | Sat, 24 Jan 2026 21:52:14 -0800 |
| parents | |
| children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/dowa/README.md Sat Jan 24 21:52:14 2026 -0800 @@ -0,0 +1,43 @@ +# dowa + +Core utility library for C. Provides memory management, string operations, and math utilities. + +## Features + +- Arena allocator and memory utilities +- String builder and manipulation +- Math helpers +- stb_ds.h for dynamic arrays and hash maps + +## Files + +| File | Description | +|------|-------------| +| `dowa.h` | Public API header | +| `d_memory.c` | Memory management (arena allocator) | +| `d_string.c` | String utilities | +| `d_math.c` | Math helpers | +| `stb_ds.h` | STB dynamic structures | +| `dowa_test.c` | Unit tests | + +## Usage + +```c +#include "dowa/dowa.h" + +// Arena allocator +Arena arena = {0}; +char* str = arena_alloc(&arena, 100); +arena_free(&arena); + +// String builder +StringBuilder sb = {0}; +sb_append(&sb, "hello"); +``` + +## Building + +```bash +bazel build //dowa:dowa +bazel test //dowa:dowa_test +```