search

premake / premake-core

Premake
https://premake.github.io/
BSD 3-Clause "New" or "Revised" License
3.17k stars 617 forks source link

Man pages #2071

Open swagtoy opened 1 year ago

swagtoy commented 1 year ago

Much like CMake does, I think some manual page generation would be nice. I have some crappy computers where I tend to avoid touching web browsers for such things, and there are times where internet is bad or I need to get quick reference and am already in a shell...

It looks perfectly possible to script this functionality. Presumably, all the .md files support everything that man pages can render. Writing a lua script to generate manpages would be cool.

Generally, names would be picked sort of like cmake does it. premake- + filename with spaces replaced with dashes. i.e. docs/endian.md would be premake-endian

--- I might try to do it! The scripting actually shouldn't be too difficult, i just have to parse some garbage... and it would be a fun task for me :-)

swagtoy commented 1 year ago

it's also possible to output man files to HTML, and... generally speaking, this would require less confusing code since you could call man directly and truncate the output and pass it to HTML.

But that would require rewriting everything to be man pages. So many not the preferred options, and I don't believe that's portable for Windows users and generally man pages are more tedious to read