diff --git a/README.md b/README.md index 9f08821..3814edc 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ # etherpad2latex +`etherpad2latex` is a simple web server which listens to requests to build +a certain etherpad containing LaTex and serves the compiled PDFs. + +I use it to create a collaborative space to work on LaTex documents of +any type. + +## Dependencies + +You'll need the [nim](https://nim-lang.org/) compiler toolchain including `nimble`, +the package manager for nim. + +## Installation + +### From source + +``` +git clone https://joachimschmidt557.xyz/gitea/joachimschmidt557/etherpad2latex +cd etherpad2latex +nimble install +```