AvtechScientific / ASL

Advanced Simulation Library - hardware accelerated multiphysics simulation platform.
http://asl.org.il
GNU Affero General Public License v3.0
217 stars 55 forks source link

manpage for asl-hardware #28

Closed ghisvail closed 7 years ago

ghisvail commented 7 years ago

Debian, and other Linux distributions, requires that all executables ship with a corresponding manpage. Please consider providing one.

AvtechScientific commented 7 years ago
  1. May we supply it as an '.org' file - 'doc/Man-Pages/asl-hardware.1.org' that can easily be converted to a man page as follows: pandoc asl-hardware.1.org -s -t man -o asl-hardware.1 ?
  2. Is shipping it enough or should we also convert/archive/install it through CMake?
ghisvail commented 7 years ago

May we supply it as an '.org' file - 'doc/Man-Pages/asl-hardware.1.org'

Absolutely.

Is shipping it enough or should we also convert/archive/install it through CMake?

Your call. AFAIC, the .org file is enough.

AvtechScientific commented 7 years ago

Done.