Willem van den Ende 7b3e46d1ec Add installation instructions to README

Include cabal install command and PATH setup guidance for installing
docster as a system-wide CLI tool.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

2025-09-02 10:47:45 +01:00

937 B

Raw Blame History

Docster

A self-contained CLI tool that converts Markdown with Mermaid diagrams into PDF or HTML using Pandoc and Mermaid CLI.

Usage

docster -pdf path/to/file.md
docster -html path/to/file.md

Mermaid code blocks (```mermaid) will be rendered to SVG and embedded.

Installation

Build and install to PATH

cabal install --installdir=$HOME/.local/bin

Make sure ~/.local/bin is in your PATH. Add to your shell config if needed:

export PATH="$HOME/.local/bin:$PATH"

Requirements

GHC + Cabal (via ghcup)
Pandoc
TeX Live (for PDF)
Mermaid CLI (npm install -g @mermaid-js/mermaid-cli)

specific versions

source ~/.ghcup/env && ghcup install ghc 9.12.2 source ~/.ghcup/env && ghcup install cabal 3.16.0.0 source ~/.ghcup/env && ghcup install hls 2.11.0.0

Development

See agents.md for information about the Claude Code agents used for Haskell refactoring in this project.

937 B Raw Blame History