From 7b3e46d1ecfc237439ab623d6ca04c1e0fbb2d01 Mon Sep 17 00:00:00 2001 From: Willem van den Ende Date: Tue, 2 Sep 2025 10:47:45 +0100 Subject: [PATCH] Add installation instructions to README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 0bbc496..297a317 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,16 @@ A self-contained CLI tool that converts Markdown with Mermaid diagrams into PDF 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)