aboutsummaryrefslogtreecommitdiff
path: root/v_windows/v/vlib/bitfield/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'v_windows/v/vlib/bitfield/README.md')
-rw-r--r--v_windows/v/vlib/bitfield/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/v_windows/v/vlib/bitfield/README.md b/v_windows/v/vlib/bitfield/README.md
new file mode 100644
index 0000000..8b82c4c
--- /dev/null
+++ b/v_windows/v/vlib/bitfield/README.md
@@ -0,0 +1,11 @@
+# Quickstart
+
+`bitfield` is a module for
+manipulating arrays of bits, i.e. series of zeroes and ones spread across an
+array of storage units (unsigned 32-bit integers).
+
+## BitField structure
+
+Bit arrays are stored in data structures called 'BitField'. The structure is
+'opaque', i.e. its internals are not available to the end user. This module
+provides API (functions and methods) for accessing and modifying bit arrays.