From fa0e56643887cf59c7dd7e59570980fe9362a24d Mon Sep 17 00:00:00 2001
From: Oglo12 <jacksonnovak@proton.me>
Date: Tue, 8 Apr 2025 15:54:35 -0500
Subject: [PATCH] [README] Fix Clay_String definition in README.md file.
Added `.isStaticallyAllocated` as a field,
and changed `int length` to `int32_t length` to
reflect the actual code.
---
README.md | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 352069d..a7c8467 100644
--- a/README.md
+++ b/README.md
@@ -1787,7 +1787,8 @@ Note: when using the debug tools, their internal colors are represented as 0-255
```C
typedef struct {
- int length;
+ bool isStaticallyAllocated;
+ int32_t length;
const char *chars;
} Clay_String;
```
@@ -1796,7 +1797,14 @@ typedef struct {
**Fields**
-**`.length`** - `int`
+**`.isStaticallyAllocated`** - `bool`
+
+Whether or not the string is statically allocated, or in other words, whether
+or not it lives for the entire lifetime of the program.
+
+---
+
+**`.length`** - `int32_t`
The number of characters in the string, _not including an optional null terminator._