Skip to content

Commit 32bba19

Browse files
author
J. Cappelletto
committed
Add additional feature list to readme: packaging, manpages and enhacement pipeline
1 parent 0708dde commit 32bba19

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,16 @@ It produces **SfM-ready frame sets** and metadata for tools like **COLMAP, Meshr
1616
> * A **CLI application** for processing videos into frames + metadata.
1717
> * A **core library** exposing `VideoFrameExtractor` and related modules.
1818
> * A **metadata writer** for reproducible CSV + YAML outputs.
19-
> * CI/CD with unit tests for schema regression.
19+
> * CI/CD with unit tests for schema regression, running on Linux and Windows.
20+
> * A modular image enhacement pipeline (pre-export stage)
21+
> * Optional packaging system (DEB/TAR)
22+
> * Linux compatible documentation (manpages)
2023
2124
**Short-term focus**: Consolidate usability, error resilience, and schema compliance before expanding to advanced feature modes (grid, enhancement, optical flow).
2225

2326
---
2427

25-
## **Key Features (v0.4.0)**
28+
## **Key Features (v0.8.0)**
2629

2730
***CLI support** for video processing with YAML or CLI configs.
2831
***Frame extraction with stride or overlap-based selection**.
@@ -31,7 +34,7 @@ It produces **SfM-ready frame sets** and metadata for tools like **COLMAP, Meshr
3134
* `frames.csv` — per-frame metadata.
3235
* `summary.yaml` — run summary + configuration snapshot.
3336
***Deterministic file structure**: images/, features/, frames.csv, summary.yaml, run.log.
34-
* **On-export frame enhancement** (future).
37+
* **On-export frame enhancement** (future).
3538
***Grid-based feature density normalization** (future).
3639

3740
---
@@ -67,7 +70,7 @@ git clone https://github.com/cappelletto/videostrip.git
6770
cd videostrip
6871

6972
# Configure and build
70-
cmake -B build -DCMAKE_BUILD_TYPE=Release
73+
cmake -B build -DCMAKE_BUILD_TYPE=Release -DBUILD_MANPAGE=OFF -DBUILD_TESTS=OFF
7174
cmake --build build -j4
7275
```
7376

@@ -126,11 +129,11 @@ processing:
126129
apply_enhancement: false
127130
enable_logging: true
128131
```
129-
Here’s a suggested **README update** to document the enhancement pipeline now that it’s wired into core. I’ve kept it minimal and in the same style/sections as your current README. Later you can extract this into a separate `docs/enhancement.md`.
130132
131133
---
132134
133135
## **Enhancement Pipeline (NEW)**
136+
TODO: extract this into a separate `docs/enhancement.md`.
134137

135138
Starting with **v0.7.x**, videostrip supports an optional **image enhancement stage** that preprocesses frames before feature extraction. This improves contrast and uniformity in underwater imagery.
136139

0 commit comments

Comments
 (0)