Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

man page documentation #25

Open
knight-of-ni opened this issue Jun 29, 2016 · 0 comments
Open

man page documentation #25

knight-of-ni opened this issue Jun 29, 2016 · 0 comments

Comments

@knight-of-ni
Copy link
Contributor

knight-of-ni commented Jun 29, 2016

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants