commit fb25a658b91eddf9346a6957603d66103c0125ab parent ef6d64fbae0c10cb115f44f878b9a8cea5e02f23 Author: Stephen Gregoratto <dev@sgregoratto.me> Date: Sat, 6 Jul 2019 10:26:14 +1000 rewrite README.md Diffstat:
| M | README.md | | | 29 | ++++++++++++++++++----------- |
1 file changed, 18 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md @@ -1,23 +1,30 @@ -# scdoc +# scdoc2mdoc -scdoc is a simple man page generator for POSIX systems written in C99. +scdoc2mdoc is a man page generator for POSIX systems written in C99. +It is a fork of the original [scdoc] that outputs `[mdoc(7)]` syntax. ## Installation - make - sudo make install +Before building, run the configure script +(a modified version of [oconfigure]). -You can pass PREFIX or DESTDIR to make if you'd like: - - make PREFIX=/usr - sudo make PREFIX=/usr install +```sh +./configure +# Or, to set make variables +CC="clang" CFLAGS="-g" ./configure PREFIX=/usr +make +sudo make DESTDIR=/path/to/destination install +``` ## Usage -See scdoc(1) +See scdoc(1), scdoc(5) ## Contributing -Send patches/bug reports to [~sircmpwn/public-inbox@lists.sr.ht][mailing-list] +Send patches/bug reports to [~toasterking/public-inbox@lists.sr.ht][mailing-list] -[mailing-list]: mailto:~sircmpwn/public-inbox@lists.sr.ht +[mailing-list]: mailto:~toasterking/public-inbox@lists.sr.ht +[scdoc]: https://git.sr.ht/~sircmpwn/scdoc +[mdoc]: https://man.openbsd.org/mdoc.7 +[oconfigure]: https://github.com/kristapsdz/oconfigure