Verified Commit 63b1f3ea authored by Jakob Moser's avatar Jakob Moser
Browse files

Update README

parent 80035563
Loading
Loading
Loading
Loading
+13 −1
Original line number Diff line number Diff line
@@ -2,9 +2,21 @@

Convert Markdown files into other formats, using the organization identity of Fachschaft Computerlinguistik.

This app uses the universal document converter **[Pandoc](https://pandoc.org/)** and the PDF converter **[WeasyPrint](https://weasyprint.org/)**. Both are excellent pieces of software and to almost all heavy lifting in this app. If you ever need to do some document conversion yourself, you will likely not need the Coliverter, and instead just use the dependencies directly. 

## Why Coliverter?

* **If your Markdown files contain Emoji or other special Unicode**: Pandocs Markdown to PDF converter uses LaTeX for elegant results, but sadly this also makes it quite bad at processing Eomi.
* **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.

## Install

We recommend using [uv](https://docs.astral.sh/uv/):
First, install using your system's package manager:

* [Pandoc](https://pandoc.org/)
* [uv](https://docs.astral.sh/uv/)

Second, install the Coliverter:

```bash
uv tool install git+https://gitlab.cl.uni-heidelberg.de/fachschaft/coliverter.git