~emersion/gyosu

7b37ddf9f9d30612286b114cbca9229dcce1af20 — Simon Ser a month ago b2b08e7
readme: add building and contributing sections
1 files changed, 15 insertions(+), 1 deletions(-)

M README.md
M README.md => README.md +15 -1
@@ 1,7 1,11 @@
# gyosu
# [gyosu]

A simple C documentation generator.

## Building

    go build .

## Usage

    gyosu [options...] <headers...>


@@ 14,8 18,18 @@ Example:
      -ffile-prefix-map=/usr/include/= \
      /usr/include/wlr/types/wlr_output.h

## Contributing

Send patches on the [mailing list], report bugs on the [issue tracker], discuss
in [#emersion on Libera Chat][IRC channel].

## License

AGPLv3, see LICENSE.

Copyright (C) 2021 Simon Ser

[gyosu]: https://sr.ht/~emersion/gyosu/
[mailing list]: https://lists.sr.ht/~emersion/public-inbox
[issue tracker]: https://todo.sr.ht/~emersion/gyosu
[IRC channel]: ircs://irc.libera.chat/#emersion