Add usage instructions in README (52c4c134) · Commits · Fachschaft / coliverter

README.md

+7 −0

Original line number	Diff line number	Diff line
		@@ -8,6 +8,7 @@ This app uses the universal document converter [Pandoc](https://pandoc.org/)

		- If your Markdown files contain Emoji or other special Unicode: Pandoc's Markdown-to-PDF converter uses LaTeX for elegant results, but sadly this also makes it quite bad at processing emoji.
		- If you want to use the Fachschaft Computerlinguistik styles: Those are integrated in the Coliverter, so that every file converted with it also looks like it was produced by the Fachschaft.
		- If you want to generate certifications of commitment (“Engagementbescheinigungen”): Coliverter has templates, can sign them cryptographically etc.

		### Showcase

		@@ -44,6 +45,12 @@ If you use `uv`, this should work out of the box (replace the paths as desired):
		coliverter examples/basic_document.md examples/out/basic_document.pdf
		```

		If you want to generate a certification of commitment, you first need to create a JSON file containing all the required data. See the `examples/` folder for details. After that, it works just as expected:

		```bash
		coliverter examples/certification_aktiver_fachschaftler.json Robby_McRobotface_Certification.pdf
		```

		## Further reading

		1. https://packaging.python.org/en/latest/tutorials/packaging-projects/