diff --git a/README.md b/README.md new file mode 100644 index 0000000..eb781df --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Requirements +* latex distribution (e.g. texlive or miktex) +* the [xcookybooky](http://www.ctan.org/tex-archive/macros/latex/contrib/xcookybooky) package +* [emerald](http://www.ctan.org/tex-archive/fonts/emerald) font + +# Installation +## xcookybooky +Download the *xcookybooky.ins* and the *xcookybooky.dtx* file. + +After that simply run `latex xcookybooky.ins` and copy the generated *xcookybooky.sty* file into your latex distribution (e.g. */usr/share/texlive/texmf-dist*). You can copy the generated *xcookybooky.cfg* into the same folder or if you want a specific config file for every xcookybooky-project you can copy it in the projects root folder. + +The last thing you have to do is to update your package list. Otherwise your new *cookybooky.sty* file will not be recognized. To update your list you have to run `texhash` or use the miktex manager. + +##emerald +Download the *fonts*, *doc* and *tex* folder and extract them into your latex distribution (e.g. */usr/share/texlive/texmf-dist*). + +Now you have to update your package list (see xcookybooky installation). + +The last step is to enable the new font map. Open a terminal and navigate to the folder containing your *emerald.map* (e.g. */usr/share/texlive/texmf-dist/fonts/map/dvips*, *fonts/map/dvips* should be the same on all systems). Now run the following command: `updmap-sys --enable Map=emerald.map` (if you're using an unix-based OS, add `sudo`.