From ad262706ce782007477e67d5003a7bff7dd6f4bd Mon Sep 17 00:00:00 2001 From: John Date: Mon, 5 Feb 2024 19:51:18 +0000 Subject: [PATCH] Add install instructions --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2374ef0..18a9e7e 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,15 @@ This is a **Work In Progress**. -`mdbook-utils` manages links, reference definitions, and code examples in Markdown files, especially `mdbook` source directories. +The `mdbook-utils` command-line tool manages links, reference definitions, and code examples in Markdown files, especially `mdbook` source directories. It is the companion tool for the ["Rust How-to"](https://www.john-cd.com/rust_howto/) book ([github](https://github.com/john-cd/rust_howto)). +## Installation + +```bash +cargo install mdbook-utils +``` + ## Usage Run the tool without arguments to display the the list of commands: @@ -109,7 +115,7 @@ The [`just`](https://just.systems/) command runner is configured to simplify com Type `just` at a shell prompt for a list of commands: -```bash +```sh just clean # Clean the `target` folder just fmt # Format the code