diff README @ 39:f9ca85d2f14c

*: rearrange some things; add avx512bw support
author Paper <paper@tflc.us>
date Sat, 26 Apr 2025 15:31:39 -0400
parents fd42f9b1b95e
children 55cadb1fac4b
line wrap: on
line diff
--- a/README	Sat Apr 26 02:54:44 2025 -0400
+++ b/README	Sat Apr 26 15:31:39 2025 -0400
@@ -138,9 +138,9 @@
 multiple translation units and pass different command line arguments
 to the compiler to enable SSE2/AVX2/Altivec etc, and detect the vector
 modes the CPU supports at runtime. vec provides an optional public API
-specifically for this use-case within `vec/impl/cpu.h`; bear in mind
-though that it is not thread-safe, so if your program is multithreaded
-you'll want to cache the results on startup.
+specifically for this use-case within `vec/cpu.h`; bear in mind though
+that it is not thread-safe, so if your program is multithreaded you'll want
+to cache the results on startup.
 
 The CPU vector detection API is extremely simple, and self-explanatory.
 You call `vec_get_CPU_features()', and it returns a bit-mask of the
@@ -177,6 +177,9 @@
 
 The heap-based API is based off the good old C malloc API:
 
+	/* heap allocation stuff is only defined here: */
+	#include "vec/mem.h"
+
 	vec_int32 *q = vec_malloc(1024 * sizeof(vec_int32));
 
 	/* q is now aligned, and ready for use with a vector aligned load