Skip to content

man page documentation #25

@knight-of-ni

Description

@knight-of-ni

We should create man page documentation of some sort. Since we are not distributing an executable, other than example programs, there is some question as to how to name it.

I'm looking at ffmpeg's manpage documentation and it looks like they've created the following man pages, which follow the names of their libraries:
ffmpeg-scaler
ffmpeg-resample
ffmpeg-codecs
ffmpeg-devices

If we followed that format, our project should have the following man pages added:
ozonebase-base (if it can be used by third parties)
ozonebase-consumers
ozonebase-encoders
ozonebase-libimg
ozonebase-libgen
ozonebase-processors
ozonebase-protocols
ozonebase-providers

or perhaps oz-libname for short

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions