aboutsummaryrefslogtreecommitdiff
path: root/python/python3-bitarray/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/python3-bitarray/README')
-rw-r--r--python/python3-bitarray/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/python/python3-bitarray/README b/python/python3-bitarray/README
new file mode 100644
index 0000000000..6aef40b34a
--- /dev/null
+++ b/python/python3-bitarray/README
@@ -0,0 +1,11 @@
+Efficient arrays of booleans
+
+This library provides an object type which efficiently represents an
+array of booleans. Bitarrays are sequence types and behave very much
+like usual lists. Eight bits are represented by one byte in a
+contiguous block of memory. The user can select between two
+representations: little-endian and big-endian. All functionality is
+implemented in C. Methods for accessing the machine representation are
+provided, including the ability to import and export buffers. This
+allows creating bitarrays that are mapped to other objects, including
+memory-mapped files.