search

illiliti / tinyramfs

Tiny initramfs written in POSIX shell
GNU General Public License v3.0
103 stars 19 forks source link

doc/*: add man pages #27

Closed fluorescent-haze closed 2 years ago

fluorescent-haze commented 2 years ago
fluorescent-haze commented 2 years ago

Thanks for taking a look. It's my first time writing a man page, so I'm bound to make mistakes. I'll fix the things you pointed out. I'll take a look at scdoc.

fluorescent-haze commented 2 years ago

I rewrote the man pages in scdoc with your requested changes, which has a very nice syntax compared to plain mdoc. I also added a job in the Makefile to 'make doc' which just runs the doc/*.scd files through scdoc. Lemme know if there's anything else you want me to change.

fluorescent-haze commented 2 years ago

Everything should be good now!

illiliti commented 2 years ago

Merged, thanks: https://github.com/illiliti/tinyramfs/commit/1314a2738823fb4a66c7a7132d5aaf6bf1a78c3b