From 9c3b12e82b159e9f20dd80b539b0129de4cc537e Mon Sep 17 00:00:00 2001 From: Jan-Erik Rediger Date: Tue, 1 Nov 2022 18:45:55 +0100 Subject: [PATCH] Document Requirements --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 52e64e6..ff93df6 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,12 @@ A preprocessor for [mdbook][] to add a page's last change date and a link to the It adds a "Last change" footer, including a date and a link to the corresponding commit. It uses the configured `git-repository-url` as the base. +## Requirements + +* The `git` command line tool. +* A configured git repository url in your `book.toml` configuration. See [Configuration](#configuration). +* Access to the git repository checkout while building your book. + ## Installation If you want to use only this preprocessor, install the tool: