premake / premake/premake-core
Man pages
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 3.6k
- Forks
- 654
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 13
Description
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 :-)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing website/docs/endian.md and the proposed premake- naming convention, then compare how CMake generates man pages. Define the Lua script’s supported Markdown input and output behavior; done means it can generate appropriately named man pages from the documentation files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua, markdown
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100