~toasterking/scdoc2mdoc

fb25a658b91eddf9346a6957603d66103c0125ab — Stephen Gregoratto a year ago ef6d64f
rewrite README.md
1 files changed, 18 insertions(+), 11 deletions(-)

M README.md
M README.md => README.md +18 -11
@@ 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