Verified Commit 1da78436 authored by Jakob Moser's avatar Jakob Moser
Browse files

Improve instructions, add running instructions

parent 06340830

README.md

+12 −3
Original line number Diff line number Diff line
@@ -4,13 +4,22 @@ The Coliverter converts Markdown files into HTML or PDF files maintaining the fs 


## Install



We recommend using [uv](https://docs.astral.sh/uv/):



```bash

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

```



You could of course also use pip (and `venv` etc., as usual):



```bash

pip install git+https://gitlab.cl.uni-heidelberg.de/fachschaft/coliverter.git

```



Or, if you use `uv`, you should be able to do something like this:

## Run



If you use `uv`, this should work out of the box:



```bash

uv init

uv add git+https://gitlab.cl.uni-heidelberg.de/fachschaft/coliverter.git

coliverter document.md -o document.pdf

```