diff --git a/README.md b/README.md index 05eebe1..8f8113f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ -# Pandoc-dokumenttipohja ja suodatin pöytäkirjoille +# Pandoc-pohja ja -suodatin kokousasiakirjoille -## Asennus +Ennakkovaatimuksena pohjan ja suodattimen käytölle on +[`pandoc`](https://pandoc.org), [`ghc`](https://haskell.org/downloads) (tai muu +haskell-kääntäjä) ja LaTeX-asennus (Unix-sukuisille käyttöjärjestelmille +`texlive`). + +Voit käyttää pohjaa kloonattuasi tämän tietovaraston koneellesi komennolla +`pandoc --template /templates/kokous.latex --filter +/filters/allekirjoittajat.hs -t pdf -o +`. Pitkän komennon kirjoittamiselta voit välttyä esim. +komentotulkin `alias`-komennolla tai kloonamalla/linkkaamalla tämän +tietovaraston hakemistot `~/.pandoc/`-hakemistoon.