Skip to content

Commit 45de91e

Browse files
authored
Simplify readme by removing bbfmux usage details
Removed detailed usage instructions for bbfmux.
1 parent e6df6a2 commit 45de91e

1 file changed

Lines changed: 0 additions & 33 deletions

File tree

readme.md

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -205,39 +205,6 @@ The `bbfmux` utility provides an example interface for managing Bound Book files
205205
### Create a new BBF
206206
You can mix individual images and folders. `bbfmux` sorts inputs alphabetically, deduplicates identical assets, and aligns data to user-defined boundaries (2^N).
207207

208-
```bash
209-
> ./bbfmux --help
210-
211-
========[ BBFMUX v3.0 ]====================================================
212-
| Bound Book Format Muxer Developed by EF1500 |
213-
===========================================================================
214-
215-
USAGE: bbfmux <INPUT_DIR|BBF_FILE> [MODE] [OPTIONS]...
216-
217-
MODES (Mutually Exclusive):
218-
(Default) Mux folder contents into a BBF container
219-
--info Display headers, metadata, and statistics
220-
--verify Validate XXH3-128/64 hashes
221-
--extract Unpack contents to disk
222-
--petrify Linearize BBF file for faster reading
223-
224-
MUXER OPTIONS:
225-
--meta=K:V[:P] Add metadata (Key:Value[:Parent])
226-
--metafile=<FILE> Read K:V:P entries from file
227-
--section=N:T[:P] Add section (Name:Target[:Parent])
228-
--sections=<FILE> Read section entries from file
229-
--ream-size=<N> Ream size exponent override (2^N)
230-
--alignment=<N> Byte alignment exponent override (2^N)
231-
--variable-ream-size Enable variable ream sizing (reccomended)
232-
233-
VERIFY OPTIONS:
234-
--section="NAME" Target specific section
235-
--asset=<ID> Target specific asset ID
236-
237-
INFO FLAGS:
238-
--hashes, --footer, --sections, --counts, --header, --metadata, --offsets
239-
```
240-
241208
```bash
242209
# Basic creation with metadata
243210
bbfmux ./chapter1/ \

0 commit comments

Comments
 (0)