From 7b37ddf9f9d30612286b114cbca9229dcce1af20 Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Tue, 24 May 2022 07:53:37 +0200 Subject: [PATCH] readme: add building and contributing sections --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 80fc3fa..25588ab 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ -# gyosu +# [gyosu] A simple C documentation generator. +## Building + + go build . + ## Usage gyosu [options...] @@ -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 -- 2.34.2