zint/docs

% docs/README 2025-03-07

For generation of "docs/manual.pdf" and "docs/manual.txt" from "manual.pmd" using a recent version of pandoc

On Ubuntu/Debian (tested on Ubuntu 22.04 and Ubuntu 24.04)

    wget https://github.com/jgm/pandoc/releases/download/3.6.3/pandoc-3.6.3-1-amd64.deb
    sudo dpkg -i pandoc-3.6.3-1-amd64.deb
For Ubuntu 22.04 (python < 3.12)
    sudo apt install python3-pip
    pip install pandoc-tablenos --user
Else for Ubuntu 24.04 (one way around "externally-managed-environment" error, PEP 668)
    sudo apt install python3-full
    python3 -m venv ~/py_envs
    source ~/py_envs/bin/activate
    pip install pandoc-tablenos
Then
    export PATH=~/.local/bin:"$PATH"
    # Temporary fix for version regex - see https://github.com/tomduck/pandoc-xnos/pull/29
    python -m pip install --force-reinstall \
        git+https://github.com/tomduck/pandoc-xnos@284474574f51888be75603e7d1df667a0890504d#egg=pandoc-xnos
    sudo apt install librsvg2-bin
    sudo apt install texlive-xetex
    sudo apt install texlive-lang-cjk
    sudo apt install fonts-wqy-microhei
    make

On Fedora (tested on Fedora Linux 38 (Workstation Edition) and Fedora Linux 40 (Workstation Edition))

    wget https://github.com/jgm/pandoc/releases/download/3.6.3/pandoc-3.6.3-linux-amd64.tar.gz
    tar xf pandoc-3.6.3-linux-amd64.tar.gz
    sudo mv -i pandoc-3.6.3/bin/pandoc /usr/local/bin
    sudo dnf install python3-pip
    pip install pandoc-tablenos --user
    export PATH=~/.local/bin:"$PATH"
    # Temporary fix for version regex - see https://github.com/tomduck/pandoc-xnos/pull/29
    python -m pip install --force-reinstall \
        git+https://github.com/tomduck/pandoc-xnos@284474574f51888be75603e7d1df667a0890504d#egg=pandoc-xnos
    sudo dnf install librsvg2-tools.x86_64
    sudo dnf install texlive-xetex
    sudo dnf install texlive-ctex.noarch
    sudo dnf install texlive-framed.noarch
    sudo dnf install texlive-fvextra.noarch
    sudo dnf install texlive-mdwtools.noarch
    sudo dnf install texlive-sectsty.noarch
    sudo dnf install texlive-xecjk.noarch
    sudo dnf install texlive-tex-gyre.noarch
    sudo dnf install wqy-microhei-fonts.noarch
    make

On Windows

    Not compatible.