Skip to content

docs: add missing --hflip and --vflip options to README#19

Merged
ogrew merged 1 commit into
mainfrom
docs/update-readme
Jun 25, 2025
Merged

docs: add missing --hflip and --vflip options to README#19
ogrew merged 1 commit into
mainfrom
docs/update-readme

Conversation

@ogrew

@ogrew ogrew commented Jun 25, 2025

Copy link
Copy Markdown
Owner

Summary

Update README.md to include the missing --hflip and --vflip options that are already implemented but were not documented.

Problem

The --hflip (horizontal flip) and --vflip (vertical flip) options were:

  • Implemented in the codebase (src/options.lisp, src/ffmpeg.lisp)
  • Working and generating proper output filenames (_HFlip.mp4, _VFlip.mp4)
  • Documented in the help text (src/help.lisp)
  • Missing from the main README documentation

This created a discrepancy between the actual functionality and user-facing documentation.

Changes Made

1. Added Usage Examples

# Flip video horizontally (left-right mirror)
visp --input sample.mp4 --hflip

# Flip video vertically (upside-down)
visp --input sample.mp4 --vflip

2. Updated Options Table

Option Argument Description
--hflip (flag) Flip video horizontally (left-right mirror).
--vflip (flag) Flip video vertically (upside-down).

3. Added Output Filename Examples

  • sample_HFlip.mp4
  • sample_VFlip.mp4

Implementation Details

These options work by:

  • Parsing: Recognized as boolean flags in parse-args-to-options
  • Processing: Applied as ffmpeg video filters (hflip, vflip)
  • Naming: Automatically append _HFlip or _VFlip to output filenames
  • Compatibility: Can be combined with other video processing options

Benefits

  • Complete documentation - README now accurately reflects all implemented features
  • Better user experience - Users can discover and use these video manipulation options
  • Consistency - Documentation matches implementation and help text
  • Professional presentation - No missing features in user-facing docs

Test plan

  • Verify README formatting renders correctly
  • Test that the documented options work as described:
    visp --input test.mp4 --hflip --dry-run
    visp --input test.mp4 --vflip --dry-run
  • Confirm output filename generation includes the expected suffixes

This documentation update requires no code changes and simply brings the README in line with existing functionality.

🤖 Generated with Claude Code

- Add usage examples for horizontal and vertical video flipping
- Include --hflip and --vflip in the options table with descriptions
- Add corresponding output filename examples (_HFlip.mp4, _VFlip.mp4)
- Ensure README accurately reflects all implemented features

These options were already implemented and documented in help text
but were missing from the main README documentation.

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

Co-Authored-By: Claude <noreply@anthropic.com>
@ogrew
ogrew merged commit 9cfc46c into main Jun 25, 2025
1 check passed
@ogrew
ogrew deleted the docs/update-readme branch June 25, 2025 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant