My working unpac space for OCaml projects in development
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

Update STATUS.md with consistent project status format

Status: STUB PROJECT - Zstd C library vendored, no OCaml code yet.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

+25 -9
+25 -9
STATUS.md
··· 4 4 5 5 ## Overview 6 6 7 - OCaml bindings for Zstandard (zstd) compression algorithm. 7 + OCaml bindings for Zstandard (zstd) compression algorithm. Currently a placeholder project with only the vendored C reference library. 8 + 9 + ## Current State 10 + 11 + - No OCaml code has been written yet 12 + - Project skeleton with dune configuration exists 13 + - Zstandard C library is vendored for reference 8 14 9 - ## Vendored C Reference 15 + ## Dependencies 10 16 11 - - `vendor/git/zstd-c/` - Zstandard C library from https://github.com/facebook/zstd 17 + - dune 3.20 (build system) 18 + - zstd C library (vendored at `vendor/git/zstd-c/`) 12 19 13 20 ## TODO 14 21 15 - - [ ] Create OCaml bindings for zstd compression/decompression 16 - - [ ] Add bytesrw integration for streaming compression 22 + - [ ] Create C stubs for zstd compression/decompression 23 + - [ ] Define OCaml interface (zstd.mli) 24 + - [ ] Implement simple compress/decompress functions 25 + - [ ] Add streaming compression/decompression support 26 + - [ ] Add bytesrw integration for streaming APIs 17 27 - [ ] Add dictionary compression support 18 28 - [ ] Write tests and benchmarks 19 29 - [ ] Consider pure OCaml port for portability 20 30 31 + ## Build & Test 32 + 33 + ```bash 34 + # Currently no build targets - stub project 35 + dune build # Will succeed but produce nothing 36 + ``` 37 + 21 38 ## Notes 22 39 23 40 Zstandard is a fast lossless compression algorithm developed by Facebook. 24 41 It provides high compression ratios and very fast decompression. 25 42 It's commonly used in Apache Parquet and other data formats. 26 43 27 - ## Existing OCaml Bindings 28 - 29 - Note: There is an existing `ocaml-zstd` opam package (https://github.com/ygrek/ocaml-zstd) 30 - that provides bindings. This project may build on or replace that implementation. 44 + **Existing OCaml Bindings**: There is an existing `ocaml-zstd` opam package 45 + (https://github.com/ygrek/ocaml-zstd) that provides bindings. This project 46 + may build on or replace that implementation.