Add info about filename extensions

Blosc · Jul 8, 2024 · 0ec41df · 0ec41df
1 parent f3aea9e
commit 0ec41df
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/README_B2ND_METALAYER.rst b/README_B2ND_METALAYER.rst
@@ -1,5 +1,5 @@
 b2nd metalayer
-++++++++++++++
+==============
 
 b2nd format is specified as a metalayer on top of a Blosc2 container for storing
 multidimensional information.  Specifically, this metalayer is named 'b2nd'

diff --git a/README_CHUNK_FORMAT.rst b/README_CHUNK_FORMAT.rst
@@ -8,7 +8,7 @@ A regular chunk is composed of a header and a blocks section::
     +---------+--------+
 
 Also, there are the so-called lazy chunks that do not have the actual compressed data,
-but only metainformation about how to read it. Lazy chunks typically appear when reading
+but only meta-information about how to read it. Lazy chunks typically appear when reading
 data from persistent media.  A lazy chunk has header and bstarts sections in place and
 in addition, an additional trailer for allowing to read the data blocks::
 

diff --git a/README_EXTENSION_FILENAMES.rst b/README_EXTENSION_FILENAMES.rst
@@ -0,0 +1,8 @@
+Extensions for Blosc2 filenames
+===============================
+
+Blosc2 has different file extensions for different purposes.  Here is a list of the currently supported ones:
+
+- `.b2frame` (but also `.b2f` or `.b2`) (Blosc2 frame): this is the main extension for storing `Blosc2 contiguous frames <README_CFRAME_FORMAT.rst>`_.
+
+- `.b2nd` (Blosc2 n-dimensional): this is just a contiguous frame file with `a metalayer for storing n-dimensional information <README_B2ND_METALAYER.rst>`_ like shape, chunkshape, blockshape and dtype.