PR#799: README: add information how to build guidelines - packaging-committee

Igor Gnatenko • 5 years ago

f7a3b10

README.md

file added

+42

		`@@ -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]]`

README.rst

file removed

-10

		`@@ -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`