Tikkun.sh

Create beautiful Torah reading sheets from the command line.

Getting Started

Prerequisites

The Nix Package Manger is used to manage dependencies and compilation. To install it, follow the instructions here.

Installing

Clone this repository:

$ git clone https://github.com/jbaum98/torahreading-maker

Creating Sheets

Using Nix

The simplest way to create a Torah reading sheet is to use nix-build to call the mkTorah fuction. For example, to create a sheet with the first 10 verses of Genesis:

$ cd torahreading-maker
$ nix-build --expr "with import <nixpkgs> {}; pkgs.callPackage ./mkTorah.nix {}" --argstr book Genesis --argstr startChapter 1 --argstr startVerse 1 --argstr endChapter 1 --argstr endVerse 10

This has the advantage of automatically caching the result in case you build the same set of verses twice. It also does the build in a temporary directory and produces no temporary files.

Using the script

You can also install a script using

$ nix-env -f . -i

from this directory. Then you can run it as.

$ mkTikkun Genesis 1 1 1 10

This will produce the same pdf as the example above, but will produce the TeX file and run TeX in the current directory. It will still cache the XML files, fonts, and LaTeX packages.

License

This project is licensed under the MIT License - see the LICENSE.txt file for details

Acknowledgements

• The Hebrew unicode XML files are downloaded from https://www.tanach.us and transformed using XSLT templates based on the ones they provide.
• libxslt is used to parse and transform the XML files to produce TeX files.
• The font family is Shlomo, a modified version of Ezra SIL designed to make it easier to distingiush between similar looking Hebrew letters such as ג and נ or ד and ר.