From f7a3b1049db60d2d429422b8f5241f11e0c1a658 Mon Sep 17 00:00:00 2001 From: Igor Gnatenko Date: Sep 24 2018 15:52:22 +0000 Subject: README: add information how to build guidelines Signed-off-by: Igor Gnatenko --- diff --git a/README.md b/README.md new file mode 100644 index 0000000..cbb1904 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# Fedora Packaging Committee + +Welcome! This is the pagure instance for the Fedora Packaging Committee. + +The pagure repository is used to store source of Packaging Guidelines, +track related issues +and accept changes via pull requests. + +For more information on the committee and its processes, +see the page in the main Fedora wiki [here](https://fedoraproject.org/wiki/Packaging_Committee). + +## Packaging Guidelines + +### Building and viewing + +Prerequisites: + +* `make` +* `podman` +* `python3` + +Run following commands and open http://localhost:8000/ + +``` +$ make +$ make serve +``` + +### Writing + +[Antora](https://antora.org/) is used for managing guidelines +and integrating it into the rest of Fedora Documentation. +You can find useful links below. + +* [AsciiDoc Syntax Quick Reference](https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/) +* [AsciiDoc Writer’s Guide](https://asciidoctor.org/docs/asciidoc-writers-guide/) + +#### Rules + +* Use [Semantic Line Breaks](http://sembr.org/) +* Prefer `https://example.com[here]` over `link:https://example.com[here]` +* Prefer `[#some-ref]` over `[[some-ref]]` diff --git a/README.rst b/README.rst deleted file mode 100644 index 27de15b..0000000 --- a/README.rst +++ /dev/null @@ -1,10 +0,0 @@ -Fedora Packaging Committee -========================== - -Welcome! This is the pagure instance for the Fedora Packaging Committee. - -The pagure issue tracker is used to track the status of drafts and sometimes -vote on them. For more information on the committee and its processes, see the -page in the main Fedora wiki here_. - -.. _here: https://fedoraproject.org/wiki/Packaging_Committee