ultravideo / uvg266

An open-source VVC encoder based on Kvazaar
BSD 3-Clause "New" or "Revised" License
225 stars 16 forks source link

Fix some spacing and line breaks in help text to keep line widths below 80 chars #7

Closed LigH-de closed 2 years ago

Jovasa commented 2 years ago

Could you please run update_readme.sh and genmanpage.sh and include those changes? We used to have make docs but that is not yet ported to CMake.

LigH-de commented 2 years ago

update_readme.sh created a README.md which did not include the help output. Redirecting it may not work in MSYS2 (mintty)? Editing manually.

genmanpage.sh did not work at all in MSYS2, only created a stub with commands to be executed to fill this file, instead of their results:

.TH UVG266 "1" "June 2022" "uvg266 v3.12)
0.2.3
${PROJECT_VERSION}-${GIT_TAG_SHORT})
"
"${CMAKE_C_COMPILER_ID}
LESS
"VS")
LESS
"VS2013")
LESS
"VS2015")
LESS
"VS2017")
LESS
"VS2019")
"VS2022")
"${UVG_COMPILER_VERSION}")
tar
"Make
${CMAKE_SOURCE_DIR}/${PROJECT_NAME}-${PROJECT_VERSION}.tar.gz
tar
cd
echo
echo
${CMAKE_SOURCE_DIR}/${PROJECT_NAME}-${PROJECT_VERSION}.tar.gz
"Checking" "User Commands"
.SH NAME
uvg266 \- open source VVC encoder
.SH SYNOPSIS
\fBuvg266 \fR\-i <input> \-\-input\-res <width>x<height> \-o <output>
.SH DESCRIPTION
Jovasa commented 2 years ago

Hmm. Good to know, anyways the README.md is more important, I'll merge this. Thanks!